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

module documentation
(source)

Session Initialization Protocol.

Documented in RFC 2543. [Superseded by 3261]

Interface | `IAuthorizer` | No interface docstring; 2/2 methods documented
Interface | `IContact` | A user of a registrar or proxy
Interface | `ILocator` | Allow looking up physical address for logical URL.
Interface | `IRegistry` | Allows registration of logical->physical URL mapping.
Class | `Base` | Base class for SIP clients and servers.
Class | `InMemoryRegistry` | A simplistic registry for a specific domain.
Class | `Message` | A SIP message.
Class | `MessagesParser` | A SIP messages parser.
Class | `Proxy` | SIP proxy.
Class | `RegisterProxy` | A proxy that allows registration for a specific domain.
Class | `Registration` | Undocumented
Class | `Request` | A Request for a URI
Class | `Response` | A Response to a URI Request
Class | `URL` | A SIP URL.
Class | `Via` | A `Via` is a SIP Via header, representing a segment of the path taken by the request.
Exception | `RegistrationError` | Registration was not possible.
Exception | `SIPError` | Undocumented
Function | `cleanRequestURL` | Clean a URL from a Request line.
Function | `dashCapitalize` | Capitalize a string, making sure to treat '-' as a word separator
Function | `parseAddress` | Return (name, uri, params) for From/To/Contact header.
Function | `parseURL` | Return string into URL object.
Function | `parseViaHeader` | Parse a Via header.
Function | `unq` | Undocumented
Constant | `PORT` | Undocumented
Variable | `longHeaders` | Undocumented
Variable | `shortHeaders` | Undocumented
Variable | `specialCases` | Undocumented
Variable | `statusCodes` | Undocumented
Variable | `_absent` | Undocumented

def cleanRequestURL(url): (source)

Clean a URL from a Request line.

def dashCapitalize(s): (source)

Capitalize a string, making sure to treat '-' as a word separator

def parseAddress(address, host=None, port=None, clean=0): (source)

Return (name, uri, params) for From/To/Contact header.

Parameters
address | Undocumented
host | Undocumented
port | Undocumented
clean | remove unnecessary info, usually for From and To headers.

def parseURL(url, host=None, port=None): (source)

Return string into URL object.

URIs are of form 'sip:user@example.com'.

def parseViaHeader(value): (source)

Parse a Via header.

Returns
`Via` | The parsed version of this header.

def unq(s): (source)

Undocumented

PORT: `int` = (source)

Undocumented

Value

    5060

longHeaders: `dict` = (source)

Undocumented

shortHeaders: `dict[str, str]` = (source)

Undocumented

specialCases: `dict[str, str]` = (source)

Undocumented

statusCodes: `dict[int, str]` = (source)

Undocumented

_absent = (source)

Undocumented