DotMSN

SBMessageHandler Members

SBMessageHandler overview

Public Instance Properties

Contacts A collection of all remote contacts present in this session
Invited Indicates if the local client was invited to the session
IsSessionEstablished Indicates if the session is ready to send/accept commands. E.g. the initial handshaking and identification has been completed.
MessageProcessor The processor to handle the messages
NSMessageHandler The nameserver that received the request for the switchboard session
P2PHandler Implements the P2P framework. This object is automatically created when a succesfull connection was made to the switchboard.

Public Instance Methods

Close Closes the switchboard session by disconnecting from the 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.
HandleMessage Handles message from the processor.
Invite Invites the specified contact to the switchboard.
SendEmoticonDefinitions Sends the definition for a list of emoticons to all other contacts in the conversation. The client-programmer must use this function if a text messages uses multiple emoticons in a single message.
SendTextMessage Sends a plain text message to all other contacts in the conversation.
SendTypingMessage Sends a 'user is typing..' message to the switchboard, and is received by all participants.
SetInvitationOverloaded. Called when a switchboard session is created on request of a remote client.
ToString (inherited from Object)Returns a String that represents the current Object.

Public Instance Events

AllContactsLeft Fired when the owner is the only contact left. If the owner leaves too the connection is automatically closed by the server.
ContactJoined Fired when a contact joins. In case of a conversation with two people in it this event is called with the remote contact specified in the event argument.
ContactLeft Fired when a contact leaves the conversation.
EmoticonDefinitionReceived Fired when a contact sends a emoticon definition.
ExceptionOccurred Occurs when an exception is thrown while handling the incoming or outgoing messages.
ServerErrorReceived Occurs when the MSN Switchboard Server sends us an error.
SessionClosed Fired when the session is closed, either by the server or by the local client.
SessionEstablished Occurs when a switchboard connection has been made and the initial handshaking commands are send. This indicates that the session is ready to invite or accept other contacts.
TextMessageReceived Fired when a message is received from any of the other contacts in the conversation.
UserTyping Fired when any of the other contacts is typing a message.

Protected Instance Properties

SessionHash The hash identifier used to define this switchboard session.
SessionId

Protected Instance Methods

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.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnAllContactsLeft Fires the AllContactsLeft event.
OnANSReceived Called when a ANS command has been received.
OnBYEReceived Called when a BYE command has been received.
OnCALReceived Called when a CAL command has been received.
OnContactJoined Fires the ContactJoined event.
OnContactLeft Fires the ContactLeft event.
OnEmoticonDefinition Fires the UserTyping event.
OnExceptionOccurred Fires the ExceptionOccurred event.
OnIROReceived Called when a IRO command has been received.
OnJOIReceived Called when a JOI command has been received.
OnMSGReceived Called when a MSG command has been received.
OnProcessorConnectCallback Called when the message processor has established a connection. This function will begin the login procedure by sending the VER command.
OnProcessorDisconnectCallback Called when the message processor has disconnected. This function will set the IsSessionEstablished to false.
OnServerErrorReceived Fires the ServerErrorReceived event.
OnSessionClosed Fires the SessionClosed event.
OnSessionEstablished Fires the SessionEstablished event and processes invitations in the queue.
OnTextMessageReceived Fires the TextMessageReceived event.
OnUserTyping Fires the UserTyping event.
OnUSRReceived Called when a USR command has been received.
ProcessInvitations Handles all remaining invitations. If no connection is yet established it will do nothing.
SendInitialMessage Send the first message to the server.
SendInvitationCommand Sends the invitation command to the switchboard server.

See Also

SBMessageHandler Class | XihSolutions.DotMSN Namespace