HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd.socket.xml
Git blob: 7baf439f34665709262bc139a7d2e657a1ace271
Lines 1001–1077 of 1,077
<term><varname>DeferTrigger=</varname></term>
<listitem><para>Takes a boolean argument, or <literal>patient</literal>. May only be used when <varname>Accept=no</varname>.
If enabled, job mode <literal>lenient</literal> instead of <literal>replace</literal> is used when
triggering the service, which means currently activating/running units that conflict with the service
won't be disturbed/brought down. Furthermore, if a conflict exists, the socket unit will wait for
current job queue to complete and potentially defer the activation by then. An upper limit of total time
to wait can be configured via <varname>DeferTriggerMaxSec=</varname>. If set to <option>yes</option>,
the socket unit will fail if all jobs have finished or the timeout has been reached but the conflict remains.
If <option>patient</option>, always wait until <varname>DeferTriggerMaxSec=</varname> elapses.
Defaults to no.</para>
<para>This setting is particularly useful if the socket unit should stay active across switch-root/soft-reboot
operations while the triggered service is stopped.</para>
<xi:include href="version-info.xml" xpointer="v258"/></listitem>
</varlistentry>
<varlistentry>
<term><varname>DeferTriggerMaxSec=</varname></term>
<listitem><para>Configures the maximum time to defer the triggering when <varname>DeferTrigger=</varname>
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 <literal>0</literal> or <literal>infinity</literal> to disable the timeout logic (the default).
</para>
<xi:include href="version-info.xml" xpointer="v258"/></listitem>
</varlistentry>
<varlistentry>
<term><varname>PassFileDescriptorsToExec=</varname></term>
<listitem><para>Takes a boolean argument. Defaults to off. If enabled, file descriptors created by
the socket unit are passed to <varname>ExecStartPost=</varname>, <varname>ExecStopPre=</varname>, and
<varname>ExecStopPost=</varname> commands from the socket unit. The passed file descriptors can be
accessed with
<citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry> as
if the commands were invoked from the associated service units. Note that
<varname>ExecStartPre=</varname> command cannot access socket file descriptors.</para>
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
</variablelist>
<xi:include href="systemd.service.xml" xpointer="shared-unit-options" />
</refsect1>
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
</simplelist></para>
<para>
For more extensive descriptions see the "systemd for Developers" series:
<simplelist type="inline">
<member><ulink url="https://0pointer.de/blog/projects/socket-activation.html">Socket Activation</ulink></member>
<member><ulink url="https://0pointer.de/blog/projects/socket-activation2.html">Socket Activation, part II</ulink></member>
<member><ulink url="https://0pointer.de/blog/projects/inetd.html">Converting inetd Services</ulink></member>
<member><ulink url="https://0pointer.de/blog/projects/socket-activated-containers.html">Socket Activated Internet Services and OS Containers</ulink></member>
</simplelist>.
</para>
</refsect1>
</refentry>