twisted.internet.endpoints._SystemdParser

class documentation

class _SystemdParser: (source)

Implements interfaces: twisted.internet.interfaces.IStreamServerEndpointStringParser, twisted.plugin.IPlugin

View In Hierarchy

Stream server endpoint string parser for the systemd endpoint type.

Method parseStreamServer Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.
Instance Variable prefix See IStreamServerEndpointStringParser.prefix.
Method _parseServer Internal parser function for _parseServer to convert the string arguments for a systemd server endpoint into structured arguments for AdoptedStreamServerEndpoint.
Instance Variable _sddaemon A ListenFDs instance used to translate an index into an actual file descriptor.
def parseStreamServer(self, reactor, *args, **kwargs): (source)
from twisted.internet.interfaces.IStreamServerEndpointStringParser

Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments.

Returns
a stream server endpoint
See Also
IStreamClientEndpointStringParserWithReactor.parseStreamClient
prefix: str = (source)
from twisted.internet.interfaces.IStreamServerEndpointStringParser
def _parseServer(self, reactor: IReactorSocket, domain: str, index: Optional[str] = None, name: Optional[str] = None) -> AdoptedStreamServerEndpoint: (source)

Internal parser function for _parseServer to convert the string arguments for a systemd server endpoint into structured arguments for AdoptedStreamServerEndpoint.

Parameters
reactor:IReactorSocketAn IReactorSocket provider.
domain:strThe domain (or address family) of the socket inherited from systemd. This is a string like "INET" or "UNIX", ie the name of an address family from the socket module, without the "AF_" prefix.
index:Optional[str]If given, the decimal representation of an integer giving the offset into the list of file descriptors inherited from systemd. Since the order of descriptors received from systemd is hard to predict, this option should only be used if only one descriptor is being inherited. Even in that case, name is probably a better idea. Either index or name must be given.
name:Optional[str]If given, the name (as defined by FileDescriptorName in the [Socket] section of a systemd service definition) of an inherited file descriptor. Either index or name must be given.
Returns
AdoptedStreamServerEndpointAn AdoptedStreamServerEndpoint which will adopt the inherited listening port when it is used to listen.
_sddaemon = (source)

A ListenFDs instance used to translate an index into an actual file descriptor.