Package twisted :: Package protocols :: Module msn :: Class MSNEventBase |
[show private | hide private]
[frames | no frames]

## Class MSNEventBase

    BaseProtocol --+
                   |
            Protocol --+
                       |
            LineReceiver --+
                           |
                          MSNEventBase

Known Subclasses:
  `MSNSwitchboardClient`, `MSNNotificationClient`, `MSNDispatchClient`

This class provides support for handling / dispatching events and is the base class of the three main client protocols (MSNDispatchClient, MSNNotificationClient, MSNSwitchboardClient)

Method Summary
| `__init__(self)`
| ``checkMessage`(self, message)` process received messages to check for file invitations and typing notifications and other control type messages
| ``connectionFailed`(self)` (Deprecated) (inherited from `Protocol`)
| ``connectionLost`(self, reason)` Called when the connection is shut down.
| ``connectionMade`(self)` Called when a connection is made.
| ``dataReceived`(self, data)` Protocol.dataReceived. (inherited from `LineReceiver`)
| ``gotBadLine`(self, line, why)` called when a handler notifies me that this line is broken
| ``gotError`(self, errorCode)` called when the server sends an error which is not in response to a sent command (ie.
| ``gotMessage`(self, message)` called when we receive a message - override in notification and switchboard clients
| `handle_MSG(self, params)`
| ``handle_UNKNOWN`(self, cmd, params)` implement me in subclasses if you want to handle unknown events
| ``lineLengthExceeded`(self, line)` Called when the maximum line length has been reached. (inherited from `LineReceiver`)
| ``lineReceived`(self, line)` Override this for when each line is received.
| ``makeConnection`(self, transport)` Make a connection to a transport and a server. (inherited from `BaseProtocol`)
| ``rawDataReceived`(self, data)` Override this for when raw data is received.
| ``sendLine`(self, line)` Sends a line to the other end of the connection. (inherited from `LineReceiver`)
| ``setLineMode`(self, extra)` Sets the line-mode of this receiver. (inherited from `LineReceiver`)
| ``setRawMode`(self)` Sets the raw mode of this receiver. (inherited from `LineReceiver`)
| ``_createIDMapping`(self, data)` return a unique transaction ID that is mapped internally to a deferred ..
| ``_fireCallback`(self, id, *args)` Fire the callback for the given id if one exists and return 1, else return false
| ``_nextTransactionID`(self)` return a usable transaction ID

Method Details

### checkMessage(self, message) process received messages to check for file invitations and typing notifications and other control type messages

### connectionLost(self, reason) Called when the connection is shut down. Clear any circular references here, and any external references to this Protocol. The connection has been closed. Parameters: `reason` (type=`twisted.python.failure.Failure`) Overrides: `twisted.internet.protocol.Protocol.connectionLost` (inherited documentation)

### connectionMade(self) 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. Overrides: `twisted.internet.protocol.BaseProtocol.connectionMade` (inherited documentation)

### gotBadLine(self, line, why) called when a handler notifies me that this line is broken

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

### gotMessage(self, message) called when we receive a message - override in notification and switchboard clients

### handle_UNKNOWN(self, cmd, params) implement me in subclasses if you want to handle unknown events

### lineReceived(self, line) Override this for when each line is received. Overrides: `twisted.protocols.basic.LineReceiver.lineReceived` (inherited documentation)

### rawDataReceived(self, data) Override this for when raw data is received. Overrides: `twisted.protocols.basic.LineReceiver.rawDataReceived` (inherited documentation)

### _createIDMapping(self, data=None) return a unique transaction ID that is mapped internally to a deferred .. also store arbitrary data if it is needed

### _fireCallback(self, id, *args) Fire the callback for the given id if one exists and return 1, else return false

### _nextTransactionID(self) return a usable transaction ID

Generated by Epydoc 1.1 on Thu May 8 13:18:51 2003 | http://epydoc.sf.net