t.p.s.Via(object) : class documentation

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

A Via is a SIP Via header, representing a segment of the path taken by the request.

See RFC 3261, sections 8.1.1.7, 18.2.2, and 20.42.

Instance Variable transport Network protocol used for this leg. (Probably either "TCP" or "UDP".) (type: str)
Instance Variable branch Unique identifier for this request. (type: str)
Instance Variable host Hostname or IP for this leg. (type: str)
Instance Variable port Port used for this leg. @type port int, or None.
Instance Variable rportRequested Whether to request RFC 3581 client processing or not. (type: bool)
Instance Variable rportValue Servers wishing to honor requests for RFC 3581 processing should set this parameter to the source port the request was received from. (type: int, or None.)
Instance Variable ttl Time-to-live for requests on multicast paths. (type: int, or None.)
Instance Variable maddr The destination multicast address, if any. (type: str, or None.)
Instance Variable hidden Obsolete in SIP 2.0. (type: bool)
Instance Variable otherParams Any other parameters in the header. (type: dict)
Method __init__ Set parameters of this Via header. All arguments correspond to attributes of the same name.
Method toString Serialize this header for use in a request or response.
Method _getrport Returns the rport value expected by the old SIP code.
Method _setrport Base._fixupNAT sets rport directly, so this method sets rportValue based on that.
transport =
Network protocol used for this leg. (Probably either "TCP" or "UDP".) (type: str)
branch =
Unique identifier for this request. (type: str)
host =
Hostname or IP for this leg. (type: str)
port =
Port used for this leg. @type port int, or None.
rportRequested =
Whether to request RFC 3581 client processing or not. (type: bool)
rportValue =
Servers wishing to honor requests for RFC 3581 processing should set this parameter to the source port the request was received from. (type: int, or None.)
ttl =
Time-to-live for requests on multicast paths. (type: int, or None.)
maddr =
The destination multicast address, if any. (type: str, or None.)
hidden =
Obsolete in SIP 2.0. (type: bool)
otherParams =
Any other parameters in the header. (type: dict)
def __init__(self, host, port=PORT, transport='UDP', ttl=None, hidden=False, received=None, rport=_absent, branch=None, maddr=None, **kw): (source)
Set parameters of this Via header. All arguments correspond to attributes of the same name.

To maintain compatibility with old SIP code, the 'rport' argument is used to determine the values of rportRequested and rportValue. If None, rportRequested is set to True. (The deprecated method for doing this is to pass True.) If an integer, rportValue is set to the given value.

Any arguments not explicitly named here are collected into the otherParams dict.

def _getrport(self): (source)
Returns the rport value expected by the old SIP code.
def _setrport(self, newRPort): (source)
Base._fixupNAT sets rport directly, so this method sets rportValue based on that.
ParametersnewRPortThe new rport value. (type: int)
def toString(self): (source)
Serialize this header for use in a request or response.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.