DotMSN

SBMessageProcessor Members

SBMessageProcessor overview

Public Instance Properties

Connected (inherited from SocketMessageProcessor) Determines whether the socket is connected
ConnectivitySettings (inherited from SocketMessageProcessor) Specifies the connection configuration used to set up the socket connection. By default the basic constructor is called.
LocalEndPoint (inherited from SocketMessageProcessor) The local end point of the connection
TransactionID Get the transaction identifier used by the last message send

Public Instance Methods

Connect (inherited from SocketMessageProcessor) Connect to the endpoint specified in the ConnectivitySettings field. If the socket is already connected this method will return immediately and leave the current connection open.
Disconnect Disconnect from the switchboard server.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
RegisterHandler (inherited from SocketMessageProcessor) Registers a message handler with this processor.
SendMessage Sends the specified SBMessage over the connection.
ToString (inherited from Object)Returns a String that represents the current Object.
UnregisterHandler (inherited from SocketMessageProcessor) Unregisters the message handler from this processor.

Public Instance Events

ConnectingException (inherited from SocketMessageProcessor) Occurs when an exception was raised while connecting to the endpoint.
ConnectionClosed (inherited from SocketMessageProcessor) Occurs when a connection is closed with the remote endpoint.
ConnectionEstablished (inherited from SocketMessageProcessor) Occurs when a connection is established with the remote endpoint.
ConnectionException (inherited from SocketMessageProcessor) Occurs when an exception was raised which caused the open connection to become invalid.
HandlerException Occurs when an exception was raised by one of the registered handlers while processing an incoming message.

Protected Instance Properties

MessageHandlers (inherited from SocketMessageProcessor) Holds all messagehandlers for this socket processor
MessagePool (inherited from SocketMessageProcessor) The messagepool used to buffer messages.
ProxyEndPoint (inherited from SocketMessageProcessor) Set when a socket is prepared with proxy server enabled. This caches the ip adress of the proxyserver and eliminates resolving it everytime a socket is prepared.

Protected Instance Methods

BeginDataReceive (inherited from SocketMessageProcessor) Starts an a-synchronous receive.
DispatchMessage Sends the received network message, from the server, to all registered handlers.
EndConnectCallback (inherited from SocketMessageProcessor) The callback used by the Socket.BeginConnect() method. The ProxySocket class behaves different from the standard Socket class. The callback is called after a connection has already been established.
EndReceiveCallback (inherited from SocketMessageProcessor) The callback used by the Socket.BeginReceive method.
EndSendCallback (inherited from SocketMessageProcessor) The callback used by the Socket.BeginReceive method.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetPreparedSocket (inherited from SocketMessageProcessor) Returns a socket which is setup using the settings in the ConnectivitySettings field. Always use this method when you want to use sockets.
IncreaseTransactionID Increases the transaction identifier by one and returns that value.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnConnected (inherited from SocketMessageProcessor) Fires the Connected event.
OnDisconnected (inherited from SocketMessageProcessor) Fires the Disconnected event.
OnHandlerException Called when a registered handler raised an exception while handling a message. Fires the HandlerException event.
OnMessageReceived Creates a SBMessage object. After that the message is send to the handler(s).
SendSocketData (inherited from SocketMessageProcessor)Overloaded. Used by descendants classes to send raw byte data over the socket connection. This function is at the moment blocking. This method uses the default socket in the SocketMessageProcessor class.

See Also

SBMessageProcessor Class | XihSolutions.DotMSN Namespace