OpenMetaverse Protocol Library Developers API Documentation
NetworkManager Class
NamespacesOpenMetaverseNetworkManager
Login Routines
NetworkManager is responsible for managing the network layer of OpenMetaverse. It tracks all the server connections, serializes outgoing traffic and deserializes incoming traffic, and provides instances of delegates for network-related events.
Declaration Syntax
C#
public 
class 
NetworkManager
Members
All Members Constructors Methods Properties Fields Events



Icon Member Description
NetworkManager(GridClient)
Default constructor

AbortLogin () () () ()
AgentAppearanceServiceURL
Server side baking service URL

BeginLogin(LoginParams)
BeginLogout () () () ()
Begins the non-blocking logout. Makes sure that the LoggedOut event is called even if the server does not send a logout reply, and Shutdown() is properly called.

CircuitCode
Unique identifier associated with our connections to simulators

Connect(IPAddress, UInt16, UInt64, Boolean, String)
Connect to a simulator

Connect(IPEndPoint, UInt64, Boolean, String)
Connect to a simulator

Connected
Shows whether the network layer is logged in to the grid or not

CurrentSim
The simulator that the logged in avatar is currently occupying

DefaultLoginParams(String, String, String, String, String)
Generate sane default values for a login request

Disconnected
Raised when the simulator sends us data containing ...

DisconnectSim(Simulator, Boolean)
Close a connection to the given simulator

EventQueueRunning
Raised when the simulator sends us data containing ...

FindSimulator(IPEndPoint)
Searches through the list of currently connected simulators to find one attached to the given IPEndPoint

GetMAC () () () ()
Get clients default Mac Address

GetPlatform () () () ()
Get current OS

InboxCount
Number of packets in the incoming queue

LoggedOut
Raised when the simulator sends us data containing ...

Login(String, String, String, String, String)
Simplified login that takes the most common and required fields

Login(String, String, String, String, String, String)
Simplified login that takes the most common fields along with a starting location URI, and can accept an MD5 string instead of a plaintext password

Login(LoginParams)
Login that takes a struct of all the values that will be passed to the login server

LoginErrorKey
Upon login failure, contains a short string key for the type of login error that occurred

LoginMessage
During login this contains a descriptive version of LoginStatusCode. After a successful login this will contain the message of the day, and after a failed login a descriptive error message will be returned

LoginProgress
Raised when the simulator sends us data containing ...

LoginResponseData
Parsed login response data

LoginSeedCapability
Seed CAPS URL returned from the login server

LoginStatusCode
Current state of logging in

Logout () () () ()
Initiate a blocking logout request. This will return when the logout handshake has completed or when
  Copy imageCopy
Settings.LOGOUT_TIMEOUT
has expired and the network layer is manually shut down

MaxAgentGroups
Maximum number of groups an agent can belong to, -1 for unlimited

OutboxCount
Number of packets in the outgoing queue

PacketSent
Raised when the simulator sends us data containing ...

RawLoginReply
The raw XML-RPC reply from the login server, exactly as it was received (minus the HTTP header)

RegisterCallback(PacketType, EventHandler < (Of < <' ( PacketReceivedEventArgs > ) > > ) )
Register an event handler for a packet. This is a low level event interface and should only be used if you are doing something not supported in the library

RegisterCallback(PacketType, EventHandler < (Of < <' ( PacketReceivedEventArgs > ) > > ) , Boolean)
Register an event handler for a packet. This is a low level event interface and should only be used if you are doing something not supported in the library

RegisterEventCallback(String, Caps . . :: . . EventQueueCallback)
Register a CAPS event handler. This is a low level event interface and should only be used if you are doing something not supported in the library

RegisterLoginResponseCallback(NetworkManager . . :: . . LoginResponseCallback)
RegisterLoginResponseCallback(NetworkManager . . :: . . LoginResponseCallback, array< String > [] () [] [] )
RemoteLoginHandler(LoginResponseData, LoginParams)
LoginParams and the initial login XmlRpcRequest were made on a remote machine. This method now initializes libomv with the results.

RequestLogout () () () ()
Initiate the logout process. The
  Copy imageCopy
Shutdown()
function needs to be manually called.

SendPacket(Packet)
Send a packet to the simulator the avatar is currently occupying

SendPacket(Packet, Simulator)
Send a packet to a specified simulator

Shutdown(NetworkManager . . :: . . DisconnectType)
Shutdown will disconnect all the sims except for the current sim first, and then kill the connection to CurrentSim. This should only be called if the logout process times out on
  Copy imageCopy
RequestLogout

Shutdown(NetworkManager . . :: . . DisconnectType, String)
Shutdown will disconnect all the sims except for the current sim first, and then kill the connection to CurrentSim. This should only be called if the logout process times out on
  Copy imageCopy
RequestLogout

SimChanged
Raised when the simulator sends us data containing ...

SimConnected
Raised when the simulator sends us data containing ...

SimConnecting
Raised when the simulator sends us data containing ...

SimDisconnected
Raised when the simulator sends us data containing ...

Simulators
All of the simulators we are currently connected to

StartLocation(String, Int32, Int32, Int32)
Build a start location URI for passing to the Login function

UnregisterCallback(PacketType, EventHandler < (Of < <' ( PacketReceivedEventArgs > ) > > ) )
Unregister an event handler for a packet. This is a low level event interface and should only be used if you are doing something not supported in the library

UnregisterEventCallback(String, Caps . . :: . . EventQueueCallback)
Unregister a CAPS event handler. This is a low level event interface and should only be used if you are doing something not supported in the library

UnregisterLoginResponseCallback(NetworkManager . . :: . . LoginResponseCallback)
Inheritance Hierarchy
Object
NetworkManager

Assembly: OpenMetaverse(Module: OpenMetaverse.dll) Version: 0.9.3.3318 (0.9.3.3318)