t.w.p.o.OscarConnection(protocol.Protocol) : class documentation

Part of twisted.words.protocols.oscar View Source View In Hierarchy

Known subclasses: twisted.words.protocols.oscar.OscarAuthenticator, twisted.words.protocols.oscar.SNACBased

No class docstring
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 Protocol:

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Method makeConnection Make a connection to a transport and a server.
def connectionMade(self): (source)
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)
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)
def readFlap(self): (source)
def dataReceived(self, data): (source)
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.

Parametersdataa 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)
def sendKeepAlive(self): (source)
def stopKeepAlive(self): (source)
def disconnect(self): (source)
send the disconnect flap, and sever the connection
API Documentation for Twisted, generated by pydoctor at 2013-11-18 18:11:01.