t.p.s.MessagesParser(basic.LineReceiver) : class documentation

Part of twisted.protocols.sip View Source View In Hierarchy

A SIP messages parser.

Expects dataReceived, dataDone repeatedly, in that order. Shouldn't be connected to actual transport.
Method __init__ Undocumented
Method reset Undocumented
Method invalidMessage Undocumented
Method dataDone Undocumented
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method handleFirstLine Expected to create self.message.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method lineReceived Override this for when each line is received.
Method messageDone Undocumented
Method rawDataReceived Override this for when raw data is received.

Inherited from LineReceiver:

Method clearLineBuffer Clear buffered data.
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method sendLine Sends a line to the other end of the connection.

Inherited from Protocol (via LineReceiver):

Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via LineReceiver, Protocol):

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

Inherited from _PauseableMixin (via LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
def __init__(self, messageReceivedCallback): (source)
Undocumented
def reset(self, remainingData=''): (source)
Undocumented
def invalidMessage(self): (source)
Undocumented
def dataDone(self): (source)
Undocumented
def dataReceived(self, data): (source)
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
def handleFirstLine(self, line): (source)
Expected to create self.message.
def lineLengthExceeded(self, line): (source)

Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

The argument 'line' contains the remainder of the buffer, starting with (at least some part) of the line which is too long. This may be more than one line, or may be only the initial portion of the line.
def lineReceived(self, line): (source)
Override this for when each line is received.
ParameterslineThe line which was received with the delimiter removed. (type: str )
def messageDone(self, remainingData=''): (source)
Undocumented
def rawDataReceived(self, data): (source)
Override this for when raw data is received.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.