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`.`Proxy``

class documentation

`class Proxy(Base): (source)`

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

View In Hierarchy

SIP proxy.

Method | `__init__` | Create new instance.
Method | `deliverResponse` | Deliver response.
Method | `getVia` | Return value of Via header for this proxy.
Method | `gotResponse` | Called with responses that are addressed at this server.
Method | `handle_request` | Override to define behavior for requests received
Method | `handle_request_default` | Default request handler.
Method | `handle_response` | Default response handler.
Method | `responseFromRequest` | Create a response to a request message.
Class Variable | `locator` | Undocumented
Instance Variable | `host` | Undocumented
Instance Variable | `port` | Undocumented
Method | `_cantForwardRequest` | Undocumented

Inherited from `Base`:

Method | `addMessage` | Undocumented
Method | `datagramReceived` | Called when a datagram is received.
Method | `sendMessage` | Send a message.
Class Variable | `debug` | Undocumented
Instance Variable | `messages` | Undocumented
Instance Variable | `parser` | Undocumented
Method | `_fixupNAT` | Undocumented

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

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 `Base`, `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, host=None, port=PORT): (source)
overrides `twisted.protocols.sip.Base.__init__`
overridden in `twisted.protocols.sip.RegisterProxy`

Create new instance.

Parameters
host | our hostname/IP as set in Via headers.
port | our port as set in Via headers.

def deliverResponse(self, responseMessage): (source)
overrides `twisted.protocols.sip.Base.deliverResponse`

Deliver response.

Destination is based on topmost Via header.

def getVia(self): (source)

Return value of Via header for this proxy.

def gotResponse(self, message, addr): (source)

Called with responses that are addressed at this server.

def handle_request(self, message, addr): (source)
overrides `twisted.protocols.sip.Base.handle_request`

Override to define behavior for requests received

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

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

Default request handler.

Default behaviour for OPTIONS and unknown methods for proxies is to forward message on to the client.

Since at the moment we are stateless proxy, that's basically everything.

def handle_response(self, message, addr): (source)
overrides `twisted.protocols.sip.Base.handle_response`

Default response handler.

def responseFromRequest(self, code, request): (source)
overrides `twisted.protocols.sip.Base.responseFromRequest`

Create a response to a request message.

locator = (source)

Undocumented

host = (source)

Undocumented

port = (source)

Undocumented

def _cantForwardRequest(self, error, message): (source)

Undocumented