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`.`python`.`sendmsg``

module documentation
(source)

sendmsg(2) and recvmsg(2) support for Python.

Function | `getSocketFamily` | Return the family of the given socket.
Function | `recvmsg` | Receive a message on a socket.
Function | `sendmsg` | Send a message on a socket.
Variable | `ReceivedMessage` | Undocumented

def getSocketFamily(socket): (source)

Return the family of the given socket.

Parameters
socket:`Socket` | The socket to get the family of.
Returns
`int` | Undocumented

def recvmsg(socket, maxSize=8192, cmsgSize=4096, flags=0): (source)

Receive a message on a socket.

Parameters
socket:`Socket` | The socket to receive the message on.
maxSize:`int` | The maximum number of bytes to receive from the socket using the datagram or stream mechanism. The default maximum is 8192.
cmsgSize:`int` | The maximum number of bytes to receive from the socket outside of the normal datagram or stream mechanism. The default maximum is 4096.
flags:`int` | Flags to affect how the message is sent. See the `MSG_` constants in the sendmsg(2) manual page. By default no flags are set.
Returns
`ReceivedMessage` | A named 3-tuple of the bytes received using the datagram/stream mechanism, a `list` of `tuple`s giving ancillary received data, and flags as an `int` describing the data received.

def sendmsg(socket, data, ancillary=[], flags=0): (source)

Send a message on a socket.

Parameters
socket:`Socket` | The socket to send the message on.
data:`bytes` | Bytes to write to the socket.
ancillary:`List[Tuple[int, int, bytes]]` | Extra data to send over the socket outside of the normal datagram or stream mechanism. By default no ancillary data is sent.
flags:`int` | Flags to affect how the message is sent. See the `MSG_` constants in the sendmsg(2) manual page. By default no flags are set.
Returns
`int` | The return value of the underlying syscall, if it succeeds.

ReceivedMessage = (source)

Undocumented