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`.`internet`.`unix`.`Client``

class documentation

`class Client(_SendmsgMixin, tcp.BaseClient): (source)`

Constructor: `Client(filename, connector, reactor, checkPID)`

Implements interfaces: `twisted.internet.interfaces.IUNIXTransport`

View In Hierarchy

A client for Unix sockets.

Method | `__init__` | No summary
Method | `getHost` | Similar to getPeer, but returns an address describing this side of the connection.
Method | `getPeer` | Get the remote address of this connection.
Instance Variable | `addr` | Undocumented
Instance Variable | `connector` | Undocumented
Instance Variable | `realAddress` | Undocumented

Inherited from `_SendmsgMixin`:

Method | `doRead` | Calls {IProtocol.dataReceived} with all available data and `IFileDescriptorReceiver.fileDescriptorReceived` once for each received file descriptor in ancillary data.
Method | `sendFileDescriptor` | Queue the given file descriptor to be sent and start trying to send it.
Method | `writeSomeData` | Send as much of `data` as possible. Also send any pending file descriptors.
Method | `_ancillaryLevelSOLSOCKETTypeSCMRIGHTS` | Processes ancillary data with level SOL_SOCKET and type SCM_RIGHTS, indicating that the ancillary data payload holds file descriptors.
Method | `_isSendBufferFull` | Determine whether the user-space send buffer for this transport is full or not.
Instance Variable | `_fileDescriptorBufferSize` | An `int` giving the maximum number of file descriptors to accept and queue for sending before pausing the registered producer, if there is one.
Instance Variable | `_sendmsgQueue` | A `list` of `int` holding file descriptors which are currently buffered before being sent.
Instance Variable | `_writeSomeDataBase` | The class which provides the basic implementation of `writeSomeData`. Ultimately this should be a subclass of `twisted.internet.abstract.FileDescriptor`. Subclasses which mix in `_SendmsgMixin` must define this.

Inherited from `BaseClient` (via `_SendmsgMixin`):

Method | `createInternetSocket` | (internal) Create a non-blocking socket using self.addressFamily, self.socketType.
Method | `doConnect` | Initiate the outgoing connection attempt.
Instance Variable | `connected` | Undocumented
Instance Variable | `logstr` | Undocumented
Instance Variable | `protocol` | Undocumented
Method | `_collectSocketDetails` | Clean up references to the socket and its file descriptor.
Method | `_connectDone` | This is a hook for when a connection attempt has succeeded.
Method | `_stopReadingAndWriting` | Implement the POSIX-ish (i.e. `twisted.internet.interfaces.IReactorFDSet`) method of detaching this socket from the reactor for `_BaseBaseClient`.
Instance Variable | `_base` | `Connection`, which is the base class of this class which has all of the useful file descriptor methods. This is used by `_TLSServerMixin` to call the right methods to directly manipulate the transport, as is necessary for writing TLS-encrypted bytes (whereas those methods on ...

Inherited from `_BaseBaseClient` (via `_SendmsgMixin`, `BaseClient`):

Method | `connectionLost` | Invoked by lower-level logic when it's time to clean the socket up. Depending on the state of the connection, either inform the attached `Connector` that the connection attempt has failed, or inform the connected ...
Method | `failIfNotConnected` | Generic method called when the attempts to connect failed. It basically cleans everything it can: call connectionFailed, stop read and write, delete socket related members.
Method | `resolveAddress` | Resolve the name that was passed to this `_BaseBaseClient`, if necessary, and then move on to attempting the connection once an address has been determined. (The connection will be attempted immediately within this function if either name resolution can be synchronous or the address was an IP address literal...
Method | `stopConnecting` | If a connection attempt is still outstanding (i.e. no connection is yet established), immediately stop attempting to connect.
Instance Variable | `addressFamily` | The address family constant (`socket.AF_INET`, `socket.AF_INET6`, `socket.AF_UNIX`) of the underlying socket of this client connection.
Instance Variable | `reactor` | The class pointed to by `_commonConnection` should set this attribute in its constructor.
Instance Variable | `socketType` | The socket type constant (`socket.SOCK_STREAM` or `socket.SOCK_DGRAM`) of the underlying socket.
Method | `_finishInit` | Called by subclasses to continue to the stage of initialization where the socket connect attempt is made.
Method | `_setRealAddress` | Set the resolved address of this `_BaseBaseClient` and initiate the connection attempt.
Class Variable | `_commonConnection` | Subclasses must provide this attribute, which indicates the `Connection`-alike class to invoke `__init__` and `connectionLost` on.
Instance Variable | `_closeSocket` | Subclasses must implement in order to close the socket in response to a terminated connection attempt.
Instance Variable | `_requiresResolution` | A flag indicating whether the address of this client will require name resolution. `True` if the hostname of said address indicates a name that must be resolved by hostname lookup, `False` if it indicates an IP address literal.

Inherited from `ClientMixin` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`):

Instance Variable | `_tlsClientDefault` | Always `True`, indicating that this is a client connection, and by default when TLS is negotiated this class will act as a TLS client.

Inherited from `Connection` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`):

Method | `getHandle` | Return the socket for this connection.
Method | `getTcpKeepAlive` | Return if `SO_KEEPALIVE` is enabled.
Method | `getTcpNoDelay` | Return if `TCP_NODELAY` is enabled.
Method | `logPrefix` | Return the prefix to log with when I own the logging thread.
Method | `readConnectionLost` | Indicates read connection was lost.
Method | `setTcpKeepAlive` | Enable/disable `SO_KEEPALIVE`.
Method | `setTcpNoDelay` | Enable/disable `TCP_NODELAY`.
Instance Variable | `socket` | Undocumented
Method | `_closeWriteConnection` | Undocumented
Method | `_dataReceived` | Undocumented

Inherited from `ConnectionMixin` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`):

Method | `loseConnection` | Close this connection after writing all pending data.
Method | `registerProducer` | Register a producer.
Method | `startTLS` | No summary
Method | `unregisterProducer` | Unregister a producer.
Method | `write` | Write some bytes to this connection, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Method | `writeSequence` | Write some bytes to this connection, scatter/gather-style, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Constant | `TLS` | A flag indicating whether TLS is currently in use on this transport. This is not a good way for applications to check for TLS, instead use `twisted.internet.interfaces.ISSLTransport`.

Inherited from `FileDescriptor` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`, `ConnectionMixin`):

Method | `doWrite` | Called when data can be written.
Method | `fileno` | File Descriptor number for select().
Method | `loseWriteConnection` | Undocumented
Method | `pauseProducing` | Pause producing data.
Method | `resumeProducing` | Resume producing data.
Method | `startReading` | Start waiting for read availability.
Method | `startWriting` | Start waiting for write availability.
Method | `stopConsuming` | Stop consuming data.
Method | `stopProducing` | Stop producing data.
Method | `stopReading` | Stop waiting for read availability.
Method | `stopWriting` | Stop waiting for write availability.
Method | `writeConnectionLost` | Indicates write connection was lost.
Constant | `SEND_LIMIT` | Undocumented
Class Variable | `bufferSize` | Undocumented
Class Variable | `disconnecting` | Undocumented
Instance Variable | `dataBuffer` | Undocumented
Instance Variable | `disconnected` | Undocumented
Instance Variable | `offset` | Undocumented
Instance Variable | `producer` | Undocumented
Instance Variable | `producerPaused` | Undocumented
Method | `_maybePauseProducer` | Possibly pause a producer, if there is one and the send buffer is full.
Method | `_postLoseConnection` | Called after a loseConnection(), when all data has been written.
Class Variable | `_writeDisconnected` | Undocumented
Instance Variable | `_tempDataBuffer` | Undocumented
Instance Variable | `_tempDataLen` | Undocumented
Instance Variable | `_writeDisconnecting` | Undocumented

Inherited from `_ConsumerMixin` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`, `ConnectionMixin`, `FileDescriptor`):

Instance Variable | `streamingProducer` | `bool` or `int`

Inherited from `_LogOwner` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`, `ConnectionMixin`, `FileDescriptor`, `_ConsumerMixin`):

Method | `_getLogPrefix` | Determine the log prefix to use for messages related to `applicationObject`, which may or may not be an `interfaces.ILoggingContext` provider.

Inherited from `_SocketCloser` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`, `ConnectionMixin`, `FileDescriptor`, `_ConsumerMixin`, `_LogOwner`):

Instance Variable | `_shouldShutdown` | Set to `True` if `shutdown` should be called before calling `close` on the underlying socket.

Inherited from `_AbortingMixin` (via `_SendmsgMixin`, `BaseClient`, `_BaseBaseClient`, `ClientMixin`, `Connection`, `ConnectionMixin`, `FileDescriptor`, `_ConsumerMixin`, `_LogOwner`, `_SocketCloser`):

Method | `abortConnection` | Aborts the connection immediately, dropping any buffered data.
Instance Variable | `_aborting` | Set to `True` when `abortConnection` is called.

def __init__(self, filename, connector, reactor=None, checkPID=0): (source)
overrides `twisted.internet.unix._SendmsgMixin.__init__`

Parameters
filename | Undocumented
connector | Undocumented
reactor | An `IReactorFDSet` provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used.
checkPID | Undocumented

def getHost(self): (source)
from `twisted.internet.interfaces.ITransport`
overrides `twisted.internet.abstract.FileDescriptor.getHost`

Similar to getPeer, but returns an address describing this side of the connection.

Returns
An `IAddress` provider.

def getPeer(self): (source)
from `twisted.internet.interfaces.ITransport`
overrides `twisted.internet.abstract.FileDescriptor.getPeer`

Get the remote address of this connection.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.

Returns
An `IAddress` provider.

addr = (source)

Undocumented

connector = (source)

Undocumented

realAddress = (source)
overrides `twisted.internet.tcp.BaseClient.realAddress`

Undocumented