twisted.protocols.mice.mouseman.MouseMan : API documentation

Method	down_left	Undocumented
Method	up_left	Undocumented
Method	down_middle	Undocumented
Method	up_middle	Undocumented
Method	down_right	Undocumented
Method	up_right	Undocumented
Method	move	Undocumented
Method	state_initial	Undocumented
Method	state_horiz	Undocumented
Method	state_vert	Undocumented
Method	state_maybemiddle	Undocumented
Method	snapshot	Undocumented
Method	dataReceived	Called whenever data is received.

Inherited from Protocol:

Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method	connectionLost	Called when the connection is shut down.

Inherited from BaseProtocol (via Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

def down_left(self): (source)

Undocumented

def up_left(self): (source)

Undocumented

def down_middle(self): (source)

Undocumented

def up_middle(self): (source)

Undocumented

def down_right(self): (source)

Undocumented

def up_right(self): (source)

Undocumented

def move(self, x, y): (source)

Undocumented

def state_initial(self, byte): (source)

Undocumented

def state_horiz(self, byte): (source)

Undocumented

def state_vert(self, byte): (source)

Undocumented

def state_maybemiddle(self, byte): (source)

Undocumented

def snapshot(self): (source)

Undocumented

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

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.

twisted.protocols.mice.mouseman.MouseMan(protocol.Protocol) class documentation

`twisted.protocols.mice.mouseman.MouseMan(protocol.Protocol)` class documentation