twisted.words.protocols.msn.MSNEventBase : API documentation

Method	__init__	Undocumented
Method	connectionLost	Called when the connection is shut down.
Method	connectionMade	Called when a connection is made.
Method	checkMessage	process received messages to check for file invitations and typing notifications and other control type messages
Method	lineReceived	Override this for when each line is received.
Method	rawDataReceived	Override this for when raw data is received.
Method	handle_MSG	Undocumented
Method	handle_UNKNOWN	implement me in subclasses if you want to handle unknown events
Method	gotMessage	called when we receive a message - override in notification and switchboard clients
Method	gotBadLine	called when a handler notifies me that this line is broken
Method	gotError	called when the server sends an error which is not in response to a sent command (ie. it has no matching transaction ID)
Method	_fireCallback	Fire the callback for the given id if one exists and return 1, else return false
Method	_nextTransactionID	return a usable transaction ID
Method	_createIDMapping	return a unique transaction ID that is mapped internally to a deferred .. also store arbitrary data if it is needed

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

def __init__(self): (source)

overridden in twisted.words.protocols.msn.NotificationClient, twisted.words.protocols.msn.SwitchboardClient

Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

overridden in twisted.words.protocols.msn.NotificationClient, twisted.words.protocols.msn.SwitchboardClient

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

overridden in twisted.words.protocols.msn.DispatchClient, twisted.words.protocols.msn.NotificationClient, twisted.words.protocols.msn.SwitchboardClient

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def _fireCallback(self, id, *args): (source)

Fire the callback for the given id if one exists and return 1, else return false

def _nextTransactionID(self): (source)

return a usable transaction ID

def _createIDMapping(self, data=None): (source)

return a unique transaction ID that is mapped internally to a deferred .. also store arbitrary data if it is needed

def checkMessage(self, message): (source)

overridden in twisted.words.protocols.msn.NotificationClient, twisted.words.protocols.msn.SwitchboardClient

process received messages to check for file invitations and typing notifications and other control type messages

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters line The line which was received with the delimiter removed. (type: bytes)

def rawDataReceived(self, data): (source)

overrides twisted.protocols.basic.LineReceiver.rawDataReceived

Override this for when raw data is received.

def handle_MSG(self, params): (source)

Undocumented

def handle_UNKNOWN(self, cmd, params): (source)

implement me in subclasses if you want to handle unknown events

def gotMessage(self, message): (source)

overridden in twisted.words.protocols.msn.SwitchboardClient

called when we receive a message - override in notification and switchboard clients

def gotBadLine(self, line, why): (source)

called when a handler notifies me that this line is broken

def gotError(self, errorCode): (source)

called when the server sends an error which is not in response to a sent command (ie. it has no matching transaction ID)

twisted.words.protocols.msn.MSNEventBase(LineReceiver) class documentation

`twisted.words.protocols.msn.MSNEventBase(LineReceiver)` class documentation