twisted.protocols.sip.MessagesParser

class documentation

class MessagesParser(basic.LineReceiver): (source)

A SIP messages parser.

Expects dataReceived, dataDone repeatedly, in that order. Shouldn't be connected to actual transport.

Method	`__init__`	Undocumented
Method	`dataDone`	Clear out any buffered data that may be hanging around.
Method	`dataReceived`	Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method	`handleFirstLine`	Expected to create self.message.
Method	`invalidMessage`	Undocumented
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.
Method	`reset`	Undocumented
Class Variable	`acceptRequests`	Undocumented
Class Variable	`acceptResponses`	Undocumented
Class Variable	`debug`	Undocumented
Class Variable	`version`	Undocumented
Instance Variable	`bodyReceived`	Undocumented
Instance Variable	`header`	Undocumented
Instance Variable	`length`	Undocumented
Instance Variable	`message`	Undocumented
Instance Variable	`messageReceived`	Undocumented
Instance Variable	`state`	Undocumented

Inherited from LineReceiver:

Method	`clearLineBuffer`	Clear buffered data.
Method	`sendLine`	Sends a line to the other end of the connection.
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.
Constant	`MAX_LENGTH`	The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable	`delimiter`	The line-ending delimiter to use. By default this is `b'\r\n'`.
Instance Variable	`line_mode`	Undocumented
Instance Variable	`_buffer`	Undocumented
Instance Variable	`_busyReceiving`	Undocumented

Inherited from Protocol (via LineReceiver):

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

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method	`connectionMade`	Called when a connection is made.
Method	`makeConnection`	Make a connection to a transport and a server.
Instance Variable	`connected`	Undocumented
Instance Variable	`transport`	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	`pauseProducing`	Undocumented
Method	`resumeProducing`	Undocumented
Method	`stopProducing`	Undocumented
Instance Variable	`paused`	Undocumented

def __init__(self, messageReceivedCallback): (source)

Undocumented

def dataDone(self): (source)

Clear out any buffered data that may be hanging around.

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.protocols.basic.LineReceiver.dataReceived

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 invalidMessage(self): (source)

Undocumented

def lineLengthExceeded(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineLengthExceeded

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)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters
line:`bytes`	The line which was received with the delimiter removed.

def messageDone(self, remainingData=''): (source)

Undocumented

def rawDataReceived(self, data): (source)

overrides twisted.protocols.basic.LineReceiver.rawDataReceived

Override this for when raw data is received.

def reset(self, remainingData=''): (source)

Undocumented

acceptRequests: int = (source)

Undocumented

acceptResponses: int = (source)

Undocumented

debug: int = (source)

Undocumented

version: str = (source)

Undocumented

bodyReceived: int = (source)

Undocumented

header = (source)

Undocumented

length = (source)

Undocumented

message = (source)

Undocumented

messageReceived = (source)

Undocumented

state: str = (source)

Undocumented