<MKMessageHandler> Protocol Reference

#import <MumbleKit/MKConnection.h>

Inheritance diagram for <MKMessageHandler>:

Instance Methods
(void)	- connection:handleBanListMessage:
(void)	- connection:handleServerSyncMessage:
(void)	- connection:handlePermissionDeniedMessage:
(void)	- connection:handleUserStateMessage:
(void)	- connection:handleUserRemoveMessage:
(void)	- connection:handleChannelStateMessage:
(void)	- connection:handleChannelRemoveMessage:
(void)	- connection:handleTextMessageMessage:
(void)	- connection:handleACLMessage:
(void)	- connection:handleQueryUsersMessage:
(void)	- connection:handleContextActionMessage:
(void)	- connection:handleContextActionModifyMessage:
(void)	- connection:handleUserListMessage:
(void)	- connection:handleVoiceTargetMessage:
(void)	- connection:handlePermissionQueryMessage:

Detailed Description

MKMessageHandler implements a set of methods that are called on the messageHandler object of a MKConnection when new control channel messages arrive. Only messages that the MKConnection itself does not know how to handle are delegated to the messageHandler.

Typically, a consumer of MKConnection does not directly set a MKMessage handler, but instead wrap the MKConnection in a MKServerModel object which

Method Documentation

- (void) connection:		(MKConnection *)	conn
handleACLMessage:		(id)	msg

Called whenever an ACL message is receieved. (See MKMessageType's ACLMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of an ACL message.

- (void) connection:		(MKConnection *)	conn
handleBanListMessage:		(id)	msg

Called whenever a ban list message is received. (See MKMessageType's BanListMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a ban list message.

- (void) connection:		(MKConnection *)	conn
handleChannelRemoveMessage:		(id)	msg

Called whenever a channel remove message is received (See MKMessageType's ChannelRemoveMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a channel remove message.

- (void) connection:		(MKConnection *)	conn
handleChannelStateMessage:		(id)	msg

Called whenever a channel state message is recieved. (See MKMessageType's ChannelStateMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a channel state message.

- (void) connection:		(MKConnection *)	conn
handleContextActionMessage:		(id)	msg

Called whenever a context action message is receieved. (See MKMessageType's ContextActionMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a context action message.

- (void) connection:		(MKConnection *)	conn
handleContextActionModifyMessage:		(id)	msg

Called whenever a context action add message is received. (See MKMessageType's ContextActionModify value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a context action add message.

- (void) connection:		(MKConnection *)	conn
handlePermissionDeniedMessage:		(id)	msg

Called whenever a permission denied message is received. (See MKMessageType's PermissionDeniedMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a permission denied message.

- (void) connection:		(MKConnection *)	conn
handlePermissionQueryMessage:		(id)	msg

Called whenever a permission query message is receieved.

Parameters

conn	The connection that received the message.
msg	An internal representation of a permission query message.

- (void) connection:		(MKConnection *)	conn
handleQueryUsersMessage:		(id)	msg

Called whenver a query users message is received. (See MKMessageType's QueryUsersMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a query users message.

- (void) connection:		(MKConnection *)	conn
handleServerSyncMessage:		(id)	msg

Called whenever a server sync message is received. (See MKMessageType's ServerSyncMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a server sync message.

- (void) connection:		(MKConnection *)	conn
handleTextMessageMessage:		(id)	msg

Called whenever a text message message is recieved. (See MKMessageType's TextMessageMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a text message message.

- (void) connection:		(MKConnection *)	conn
handleUserListMessage:		(id)	msg

Called whenever a user list message is received. (See MKMessageType's UserListMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a user list message.

- (void) connection:		(MKConnection *)	conn
handleUserRemoveMessage:		(id)	msg

Called whenever a user remove message is received. (See MKMessageType's UserRemoveMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a user remove message.

- (void) connection:		(MKConnection *)	conn
handleUserStateMessage:		(id)	msg

Called whenever a user state message is receieved. (See MKMessageType's UserStateMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a user state message.

- (void) connection:		(MKConnection *)	conn
handleVoiceTargetMessage:		(id)	msg

Called whenever a voice target message is receieved. (See MKMessageType's VoiceTargetMessage value).

Parameters

conn	The connection that received the message.
msg	An internal representation of a voice target message.

---

The documentation for this protocol was generated from the following file:

• /Users/mkrautz/Documents/mumble-iphoneos/MumbleKit/src/MumbleKit/MKConnection.h