DotMSN |

# SocketMessageProcessor Members

SocketMessageProcessor overview

#### Public Instance Constructors

SocketMessageProcessor Constructor | Constructor to instantiate a SocketMessageProcessor object.

#### Public Instance Properties

Connected | Determines whether the socket is connected
ConnectivitySettings | Specifies the connection configuration used to set up the socket connection. By default the basic constructor is called.
LocalEndPoint | The local end point of the connection

#### Public Instance Methods

Connect | 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 the current connection by sending the OUT command and closing the socket. If the connection is already closed nothing happens (no exception is thrown).
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 | Registers a message handler with this processor.
SendMessage | The base class does nothing here. Descendant classes should implement this function by encoding the message in a byte array and send it using the SendSocketData method.
ToString (inherited from Object) | Returns a String that represents the current Object.
UnregisterHandler | Unregisters the message handler from this processor.

#### Public Instance Events

ConnectingException | Occurs when an exception was raised while connecting to the endpoint.
ConnectionClosed | Occurs when a connection is closed with the remote endpoint.
ConnectionEstablished | Occurs when a connection is established with the remote endpoint.
ConnectionException | Occurs when an exception was raised which caused the open connection to become invalid.

#### Protected Instance Properties

MessageHandlers | Holds all messagehandlers for this socket processor
MessagePool | The messagepool used to buffer messages.
ProxyEndPoint | 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 | Starts an a-synchronous receive.
EndConnectCallback | 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 | The callback used by the Socket.BeginReceive method.
EndSendCallback | 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 | Returns a socket which is setup using the settings in the ConnectivitySettings field. Always use this method when you want to use sockets.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
OnConnected | Fires the Connected event.
OnDisconnected | Fires the Disconnected event.
OnMessageReceived | This methods is called when data is retreived from the message pool. It represents a single message. The processor has to convert this to a NetworkMessage object and pass it on to a MessageHandler.
SendSocketData | 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

SocketMessageProcessor Class | XihSolutions.DotMSN.Core Namespace