Package sparked :: Package hardware :: Module inputevent :: Class InputEventProtocol

Class InputEventProtocol

twisted.internet.protocol.BaseProtocol --+    
                                         |    
        twisted.internet.protocol.Protocol --+
                                             |
                                            InputEventProtocol

Receives events from an input device.

Instance Methods

[hide private]

connectionMade(self)
Called when a connection is made.

source code

dataReceived(self, data)
Called whenever data is received.

source code

eventReceived(self, event)
Input event has been received.

source code

Inherited from twisted.internet.protocol.Protocol: connectionLost

Inherited from twisted.internet.protocol.BaseProtocol: __providedBy__, makeConnection

Class Variables

[hide private]

Inherited from twisted.internet.protocol.Protocol: __implemented__, __provides__

Inherited from twisted.internet.protocol.BaseProtocol: connected, transport

Method Details

[hide private]

connectionMade(self)

source code

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)

dataReceived(self, data)

source code

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters:

data - a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

Overrides: twisted.internet.protocol.Protocol.dataReceived

(inherited documentation)

eventReceived(self, event)

source code

Input event has been received. Override this function to do something useful.