twisted.words.protocols.oscar.OscarConnection : API documentation

Method	connectionMade	Called when a connection is made.
Method	connectionLost	Called when the connection is shut down.
Method	sendFLAP	Undocumented
Method	readFlap	Undocumented
Method	dataReceived	Called whenever data is received.
Method	setKeepAlive	Undocumented
Method	sendKeepAlive	Undocumented
Method	stopKeepAlive	Undocumented
Method	disconnect	send the disconnect flap, and sever the connection

Inherited from BaseProtocol (via Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from BaseProtocol (via Protocol):

Method

makeConnection

Make a connection to a transport and a server.

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

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 connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

overridden in twisted.words.protocols.oscar.OSCARService

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 sendFLAP(self, data, channel=2): (source)

Undocumented

def readFlap(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.

def setKeepAlive(self, t): (source)

Undocumented

def sendKeepAlive(self): (source)

Undocumented

def stopKeepAlive(self): (source)

Undocumented

def disconnect(self): (source)

send the disconnect flap, and sever the connection

twisted.words.protocols.oscar.OscarConnection(protocol.Protocol) class documentation

`twisted.words.protocols.oscar.OscarConnection(protocol.Protocol)` class documentation