summaryrefslogtreecommitdiff
path: root/man/sd_notify.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2017-11-13 18:26:04 +0100
committerLennart Poettering <lennart@poettering.net>2017-11-27 17:04:04 +0100
commite78ee06de1011aaa8de7a60d98fc18daee2edb26 (patch)
treef30edb4550a0ffc68da532d0eff0de4f470fa857 /man/sd_notify.xml
parent8d1ab18a466b44a8641899f871fa322e395fdd36 (diff)
downloadsystemd-e78ee06de1011aaa8de7a60d98fc18daee2edb26.tar.gz
core: add a new sd_notify() message for removing fds from the FD store again
Currenly the only way to remove fds from the fdstore is to fully stop the service, or to somehow trigger POLLERR/POLLHUP on the fd, in which case systemd will remove the fd automatically. Let's add another way: a new message that can be sent to remove fds explicitly, given their name.
Diffstat (limited to 'man/sd_notify.xml')
-rw-r--r--man/sd_notify.xml31
1 files changed, 16 insertions, 15 deletions
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 3ba242b90b..a53b1ab33e 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -235,24 +235,25 @@
</varlistentry>
<varlistentry>
+ <term>FDSTOREREMOVE=1</term>
+
+ <listitem><para>Removes file descriptors from the file descriptor store. This field needs to be combined with
+ <varname>FDNAME=</varname> to specify the name of the file descriptors to remove.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>FDNAME=…</term>
- <listitem><para>When used in combination with
- <varname>FDSTORE=1</varname>, specifies a name for the
- submitted file descriptors. This name is passed to the service
- during activation, and may be queried using
+ <listitem><para>When used in combination with <varname>FDSTORE=1</varname>, specifies a name for the submitted
+ file descriptors. When used with <varname>FDSTOREREMOVE=1</varname>, specifies the name for the file
+ descriptors to remove. This name is passed to the service during activation, and may be queried using
<citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>. File
- descriptors submitted without this field set, will implicitly
- get the name <literal>stored</literal> assigned. Note that, if
- multiple file descriptors are submitted at once, the specified
- name will be assigned to all of them. In order to assign
- different names to submitted file descriptors, submit them in
- separate invocations of
- <function>sd_pid_notify_with_fds()</function>. The name may
- consist of any ASCII character, but must not contain control
- characters or <literal>:</literal>. It may not be longer than
- 255 characters. If a submitted name does not follow these
- restrictions, it is ignored.</para></listitem>
+ descriptors submitted without this field set, will implicitly get the name <literal>stored</literal>
+ assigned. Note that, if multiple file descriptors are submitted at once, the specified name will be assigned to
+ all of them. In order to assign different names to submitted file descriptors, submit them in separate
+ invocations of <function>sd_pid_notify_with_fds()</function>. The name may consist of arbitrary ASCII
+ characters except control characters or <literal>:</literal>. It may not be longer than 255 characters. If a
+ submitted name does not follow these restrictions, it is ignored.</para></listitem>
</varlistentry>
</variablelist>