# ``twisted`.`internet`.`endpoints`.`UNIXClientEndpoint``

class documentation

`class UNIXClientEndpoint: (source)`

Implements interfaces: `twisted.internet.interfaces.IStreamClientEndpoint`

View In Hierarchy

UnixSocket client endpoint.

Method | `__init__` |
Method | `connect` | Implement `IStreamClientEndpoint.connect` to connect via a UNIX Socket
Instance Variable | `_checkPID` | Undocumented
Instance Variable | `_path` | Undocumented
Instance Variable | `_reactor` | Undocumented
Instance Variable | `_timeout` | Undocumented

def __init__(self, reactor, path, timeout=30, checkPID=0): (source)

Parameters
reactor | An `IReactorUNIX` provider.
path:str | The path to the Unix socket file, used when connecting
timeout:int | Number of seconds to wait before assuming the connection has failed.
checkPID:bool | If True, check for a pid file to verify that a server is listening.

def connect(self, protocolFactory): (source)
from `twisted.internet.interfaces.IStreamClientEndpoint`
Implement `IStreamClientEndpoint.connect` to connect via a UNIX Socket
_checkPID = (source)

Undocumented

_path = (source)

Undocumented

_reactor = (source)

Undocumented

_timeout = (source)

Undocumented