view release on metacpan or  search on metacpan

lib/Config/Model/models/Systemd/Section/Socket.pl  view on Meta::CPAN

operations while the triggered service is stopped.',
      'DeferTriggerMaxSec' => 'Configures the maximum time to defer the triggering when C<DeferTrigger>
is enabled. If the service cannot be activated within the specified time, the socket will be considered
failed and get terminated. Takes a unit-less value in seconds, or a time span value such as "5min 20s".
Pass C<0> or C<infinity> to disable the timeout logic (the default).
',
      'DirectoryMode' => 'If listening on a file system socket or FIFO,
the parent directories are automatically created if needed.
This option specifies the file system access mode used when
creating these directories. Takes an access mode in octal
notation. Defaults to 0755.',
      'ExecStartPost' => 'Takes one or more command lines, which are
executed before or after the listening sockets/FIFOs are
created and bound, respectively. The first token of the
command line must be an absolute filename, then followed by
arguments for the process. Multiple command lines may be
specified following the same scheme as used for
C<ExecStartPre> of service unit
files.',
      'ExecStartPre' => '*ExecStartPost',
      'ExecStopPost' => 'Additional commands that are executed before
or after the listening sockets/FIFOs are closed and removed,
respectively. Multiple command lines may be specified
following the same scheme as used for
C<ExecStartPre> of service unit
files.',
      'ExecStopPre' => '*ExecStopPost',
      'FileDescriptorName' => 'Assigns a name to all file descriptors this socket unit encapsulates.
This is useful to help activated services identify specific file descriptors, if multiple fds are passed.
Services may use the
L<sd_listen_fds_with_names(3)>
call to acquire the names configured for the received file descriptors. Names may contain any ASCII character,
but must exclude control characters and C<:>, and must be at most 255 characters in length.
If this setting is not used, the file descriptor name defaults to the name of the socket unit
(including its C<.socket> suffix) when C<Accept=no>,
C<connection> otherwise.',
      'FlushPending' => 'Takes a boolean argument. May only be used when
C<Accept=no>. If yes, the socket\'s buffers are cleared after the
triggered service exited. This causes any pending data to be
flushed and any pending incoming connections to be rejected. If no, the
socket\'s buffers will not be cleared, permitting the service to handle any
pending connections after restart, which is the usually expected behaviour.
Defaults to C<no>.
',
      'FreeBind' => 'Takes a boolean value. Controls whether the socket can be bound to non-local IP
addresses. This is useful to configure sockets listening on specific IP addresses before those IP
addresses are successfully configured on a network interface. This sets the
C<IP_FREEBIND>/C<IPV6_FREEBIND> socket option. For robustness
reasons it is recommended to use this option whenever you bind a socket to a specific IP
address. Defaults to C<false>.',
      'IPTOS' => 'Takes an integer argument controlling the IP Type-Of-Service field for packets
generated from this socket.  This controls the C<IP_TOS> socket option (see
L<ip(7)> for
details.). Either a numeric string or one of C<low-delay>, C<throughput>,
C<reliability> or C<low-cost> may be specified.',
      'IPTTL' => 'Takes an integer argument controlling the IPv4 Time-To-Live/IPv6 Hop-Count field for
packets generated from this socket. This sets the
C<IP_TTL>/C<IPV6_UNICAST_HOPS> socket options (see L<ip(7)> and
L<ipv6(7)> for
details.)',
      'KeepAlive' => 'Takes a boolean argument. If true, the TCP/IP stack will send a keep alive message
after 2h (depending on the configuration of
C</proc/sys/net/ipv4/tcp_keepalive_time>) for all TCP streams accepted on this
socket. This controls the C<SO_KEEPALIVE> socket option (see L<socket(7)> and
the L<TCP Keepalive
HOWTO|http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/> for details.) Defaults to C<false>.',
      'KeepAliveIntervalSec' => 'Takes time (in seconds) as argument between individual keepalive probes, if the
socket option C<SO_KEEPALIVE> has been set on this socket. This controls the
C<TCP_KEEPINTVL> socket option (see L<socket(7)> and
the L<TCP Keepalive
HOWTO|http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/> for details.) Default value is 75 seconds.',
      'KeepAliveProbes' => 'Takes an integer as argument. It is the number of
unacknowledged probes to send before considering the
connection dead and notifying the application layer. This
controls the TCP_KEEPCNT socket option (see
L<socket(7)>
and the L<TCP
Keepalive HOWTO|http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/> for details.) Default value is
9.',
      'KeepAliveTimeSec' => 'Takes time (in seconds) as argument. The connection needs to remain
idle before TCP starts sending keepalive probes. This controls the TCP_KEEPIDLE
socket option (see
L<socket(7)>
and the L<TCP
Keepalive HOWTO|http://www.tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/> for details.)
Default value is 7200 seconds (2 hours).',
      'ListenDatagram' => 'Specifies an address to listen on for a stream
(C<SOCK_STREAM>), datagram
(C<SOCK_DGRAM>), or sequential packet
(C<SOCK_SEQPACKET>) socket, respectively.
The address can be written in various formats:

If the address starts with a slash
(C</>), it is read as file system socket in
the C<AF_UNIX> socket family.

If the address starts with an at symbol
(C<@>), it is read as abstract namespace
socket in the C<AF_UNIX> family. The
C<@> is replaced with a
C<NUL> character before binding. For
details, see
L<unix(7)>.

If the address string is a single number, it is read as
port number to listen on via IPv6. Depending on the value of
C<BindIPv6Only> (see below) this might result
in the service being available via both IPv6 and IPv4
(default) or just via IPv6.

If the address string is a string in the format
C<v.w.x.y:z>, it is interpreted
as IPv4 address v.w.x.y and port z.

If the address string is a string in the format
C<[x]:y>, it is interpreted as
IPv6 address x and port y. An optional
interface scope (interface name or number) may be specified after a C<%> symbol:
C<[x]:y%dev>.
Interface scopes are only useful with link-local addresses, because the kernel ignores them in other
cases. Note that if an address is specified as IPv6, it might still make the service available via
IPv4 too, depending on the C<BindIPv6Only> setting (see below).

If the address string is a string in the format
C<vsock:x:y>, it is read as CID
x on a port y address in the
C<AF_VSOCK> family.  The CID is a unique 32-bit integer identifier in
C<AF_VSOCK> analogous to an IP address.  Specifying the CID is optional, and may be
set to the empty string. C<vsock> may be replaced with
C<vsock-stream>, C<vsock-dgram> or C<vsock-seqpacket>
to force usage of the corresponding socket type.

Note that C<SOCK_SEQPACKET> (i.e.
C<ListenSequentialPacket>) is only available
for C<AF_UNIX> sockets.
C<SOCK_STREAM> (i.e.
C<ListenStream>) when used for IP sockets
refers to TCP sockets, C<SOCK_DGRAM> (i.e.
C<ListenDatagram>) to UDP.

These options may be specified more than once, in which
case incoming traffic on any of the sockets will trigger
service activation, and all listed sockets will be passed to
the service, regardless of whether there is incoming traffic
on them or not. If the empty string is assigned to any of