Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`protocols`.`sip`.`Base``

class documentation

`class Base(protocol.DatagramProtocol): (source)`

Known subclasses: `twisted.protocols.sip.Proxy`

View In Hierarchy

Base class for SIP clients and servers.

Method | `__init__` | Undocumented
Method | `addMessage` | Undocumented
Method | `datagramReceived` | Called when a datagram is received.
Method | `deliverResponse` | Deliver response.
Method | `handle_request` | Override to define behavior for requests received
Method | `handle_response` | Override to define behavior for responses received.
Method | `responseFromRequest` | Create a response to a request message.
Method | `sendMessage` | Send a message.
Class Variable | `debug` | Undocumented
Instance Variable | `messages` | Undocumented
Instance Variable | `parser` | Undocumented
Method | `_fixupNAT` | Undocumented

Inherited from `DatagramProtocol`:

Method | `connectionRefused` | Called due to error from write in connected mode.
Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Instance Variable | `transport` | The transport with which this protocol is associated, if it is associated with one.

Inherited from `AbstractDatagramProtocol` (via `DatagramProtocol`):

Method | `__getstate__` | Undocumented
Method | `doStart` | Make sure startProtocol is called.
Method | `doStop` | Make sure stopProtocol is called.
Method | `makeConnection` | Make a connection to a transport and a server.
Method | `startProtocol` | Called when a transport is connected to this protocol.
Method | `stopProtocol` | Called when the transport is disconnected.
Class Variable | `noisy` | Undocumented
Instance Variable | `numPorts` | Undocumented

def __init__(self): (source)
overridden in `twisted.protocols.sip.Proxy`

Undocumented

def addMessage(self, msg): (source)

Undocumented

def datagramReceived(self, data, addr): (source)
overrides `twisted.internet.protocol.AbstractDatagramProtocol.datagramReceived`

Called when a datagram is received.

Parameters
data | Undocumented
addr | tuple of source of datagram.
datagram | the bytes received from the transport.

def deliverResponse(self, responseMessage): (source)
overridden in `twisted.protocols.sip.Proxy`

Deliver response.

Destination is based on topmost Via header.

def handle_request(self, message, addr): (source)
overridden in `twisted.protocols.sip.Proxy`

Override to define behavior for requests received

Parameters
message:`Message` | Undocumented
addr:`tuple` | Undocumented

def handle_response(self, message, addr): (source)
overridden in `twisted.protocols.sip.Proxy`

Override to define behavior for responses received.

Parameters
message:`Message` | Undocumented
addr:`tuple` | Undocumented

def responseFromRequest(self, code, request): (source)
overridden in `twisted.protocols.sip.Proxy`

Create a response to a request message.

def sendMessage(self, destURL, message): (source)

Send a message.

Parameters
destURL | `URL`. This should be a *physical* URL, not a logical one.
message | The message to send.

debug: `bool` = (source)

Undocumented

messages: `list` = (source)

Undocumented

parser = (source)

Undocumented

def _fixupNAT(self, message, sourcePeer): (source)

Undocumented