view release on metacpan or  search on metacpan

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

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
these options, the list of addresses to listen on is reset,
all prior uses of any of these options will have no
effect.

It is also possible to have more than one socket unit
for the same service when using C<Service>,
and the service will receive all the sockets configured in all
the socket units. Sockets configured in one unit are passed in
the order of configuration, but no ordering between socket
units is specified.

If an IP address is used here, it is often desirable to
listen on it before the interface it is configured on is up
and running, and even regardless of whether it will be up and
running at any point. To deal with this, it is recommended to
set the C<FreeBind> option described
below. I< Optional. Type list of uniline.  > 

=head2 ListenFIFO

Specifies a file system FIFO (see L<fifo(7)> for
details) to listen on.	This expects an absolute file system path as argument.	Behavior otherwise is
very similar to the C<ListenDatagram> directive above. I< Optional. Type list of uniline.  > 

=head2 ListenSpecial

Specifies a special file in the file system to
listen on. This expects an absolute file system path as
argument. Behavior otherwise is very similar to the
C<ListenFIFO> directive above. Use this to
open character device nodes as well as special files in
C</proc/> and
C</sys/>. I< Optional. Type list of uniline.  > 

=head2 ListenNetlink

Specifies a Netlink family to create a socket
for to listen on. This expects a short string referring to the
C<AF_NETLINK> family name (such as
C<audit> or C<kobject-uevent>)
as argument, optionally suffixed by a whitespace followed by a
multicast group integer. Behavior otherwise is very similar to
the C<ListenDatagram> directive
above. I< Optional. Type list of uniline.  > 

=head2 ListenMessageQueue

Specifies a POSIX message queue name to listen on (see L<mq_overview(7)>
for details). This expects a valid message queue name (i.e. beginning with
C</>). Behavior otherwise is very similar to the C<ListenFIFO>
directive above. On Linux message queue descriptors are actually file descriptors and can be
inherited between processes. I< Optional. Type list of uniline.  > 

=head2 ListenUSBFunction

Specifies a L<USB
FunctionFS|https://docs.kernel.org/usb/functionfs.html> endpoints location to listen on, for
implementation of USB gadget functions. This expects an
absolute file system path of a FunctionFS mount point as the argument.
Behavior otherwise is very similar to the C<ListenFIFO>
directive above. Use this to open the FunctionFS endpoint
C<ep0>. When using this option, the
activated service has to have the
C<USBFunctionDescriptors> and
C<USBFunctionStrings> options set.
I< Optional. Type list of uniline.  > 

=head2 SocketProtocol

Takes one of C<udplite>,
C<sctp> or C<mptcp>. The socket will use
the UDP-Lite (C<IPPROTO_UDPLITE>), SCTP
(C<IPPROTO_SCTP>) or MPTCP
(C<IPPROTO_MPTCP>) protocol, respectively. I< Optional. Type enum. choice: 'mptcp', 'sctp', 'udplite'.  > 

=head2 BindIPv6Only

Takes one of C<default>,
C<both> or C<ipv6-only>. Controls
the IPV6_V6ONLY socket option (see
L<ipv6(7)>
for details). If C<both>, IPv6 sockets bound
will be accessible via both IPv4 and IPv6. If
C<ipv6-only>, they will be accessible via IPv6
only. If C<default> (which is the default,
surprise!), the system wide default setting is used, as
controlled by
C</proc/sys/net/ipv6/bindv6only>, which in
turn defaults to the equivalent of
C<both>. I< Optional. Type enum. choice: 'both', 'default', 'ipv6-only'.  > 

=head2 Backlog

Takes an unsigned 32-bit integer argument. Specifies the number of connections to
queue that have not been accepted yet. This setting matters only for stream and sequential packet
sockets. See
L<listen(2)> for
details. Defaults to 4294967295. Note that this value is silently capped by the
C<net.core.somaxconn> sysctl, which typically defaults to 4096, so typically
the sysctl is the setting that actually matters. I< Optional. Type uniline.  > 

=head2 BindToDevice

Specifies a network interface name to bind this socket to. If set, traffic will only
be accepted from the specified network interfaces. This controls the
C<SO_BINDTODEVICE> socket option (see L<socket(7)> for
details). If this option is used, an implicit dependency from this socket unit on the network
interface device unit is created
(see L<systemd.device(5)>).
Note that setting this parameter might result in additional dependencies to be added to the unit (see
above). I< Optional. Type uniline.  > 

=head2 SocketUser

Takes a UNIX user/group name. When specified, all C<AF_UNIX>
sockets, FIFO nodes, and message queues are owned by the specified user and group. If unset (the
default), the nodes are owned by the root user/group (if run in system context) or the invoking
user/group (if run in user context).  If only a user is specified but no group, then the group is
derived from the user's default group. I< Optional. Type uniline.  > 

=head2 SocketGroup