class documentation

class twisted.protocols.sip.MessagesParser(basic.LineReceiver): (source)

View In Hierarchy

A SIP messages parser.

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

Class Variable version Undocumented
Class Variable acceptResponses Undocumented
Class Variable acceptRequests Undocumented
Instance Variable state Undocumented
Class Variable debug Undocumented
Method __init__ Undocumented
Instance Variable messageReceived Undocumented
Method reset Undocumented
Instance Variable length Undocumented
Instance Variable bodyReceived Undocumented
Instance Variable message Undocumented
Instance Variable header Undocumented
Method invalidMessage 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 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:

Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Class Variable 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.
Instance Variable line_mode Undocumented
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.
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via LineReceiver):

Class Variable factory Undocumented
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 LineReceiver, Protocol):

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

Inherited from _PauseableMixin (via LineReceiver):

Instance Variable paused Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
version = (source)

Undocumented

(type: str)
acceptResponses = (source)

Undocumented

(type: int)
acceptRequests = (source)

Undocumented

(type: int)
state = (source)

Undocumented

(type: str)
debug = (source)

Undocumented

(type: int)
def __init__(self, messageReceivedCallback): (source)

Undocumented

messageReceived = (source)

Undocumented

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

Undocumented

length = (source)

Undocumented

bodyReceived = (source)

Undocumented

(type: int)
message = (source)

Undocumented

header = (source)

Undocumented

def invalidMessage(self): (source)

Undocumented

def dataDone(self): (source)

Clear out any buffered data that may be hanging around.

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: bytes)
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 20.12.1 at 2021-02-28 19:53:36.