diff options
Diffstat (limited to 'man/sd_event_add_inotify.xml')
| -rw-r--r-- | man/sd_event_add_inotify.xml | 70 |
1 files changed, 45 insertions, 25 deletions
diff --git a/man/sd_event_add_inotify.xml b/man/sd_event_add_inotify.xml index 7781d8e..ed26c8a 100644 --- a/man/sd_event_add_inotify.xml +++ b/man/sd_event_add_inotify.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_inotify" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -19,6 +19,7 @@ <refname>sd_event_add_inotify</refname> <refname>sd_event_add_inotify_fd</refname> <refname>sd_event_source_get_inotify_mask</refname> + <refname>sd_event_source_get_inotify_path</refname> <refname>sd_event_inotify_handler_t</refname> <refpurpose>Add an "inotify" file system inode event source to an event loop</refpurpose> @@ -60,7 +61,13 @@ <funcprototype> <funcdef>int <function>sd_event_source_get_inotify_mask</function></funcdef> <paramdef>sd_event_source *<parameter>source</parameter></paramdef> - <paramdef>uint32_t *<parameter>mask</parameter></paramdef> + <paramdef>uint32_t *<parameter>ret</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_event_source_get_inotify_path</function></funcdef> + <paramdef>sd_event_source *<parameter>source</parameter></paramdef> + <paramdef>const char **<parameter>ret</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -133,6 +140,12 @@ event source created previously with <function>sd_event_add_inotify()</function>. It takes the event source object as the <parameter>source</parameter> parameter and a pointer to a <type>uint32_t</type> variable to return the mask in.</para> + + <para><function>sd_event_source_get_inotify_path()</function> retrieves the target path of the configured + inotify watch of an event source created previously with <function>sd_event_add_inotify()</function>. It + takes the event source object as the <parameter>source</parameter> parameter and a pointer to a + <type>const char **</type> variable to return the path in. The caller must not free the returned path. + </para> </refsect1> <refsect1> @@ -163,7 +176,12 @@ <varlistentry> <term><constant>-ESTALE</constant></term> - <listitem><para>The event loop is already terminated.</para></listitem> + <listitem> + <para>Returned by <function>sd_event_source_add_inotify()</function> or + <function>sd_event_source_add_inotify_fd()</function> when the event loop is already terminated. + Returned by <function>sd_event_source_get_inotify_path()</function> when no active inode data is + assigned to the event source, e.g. when the event source is disabled.</para> + </listitem> </varlistentry> @@ -183,18 +201,19 @@ <varlistentry> <term><constant>-EBADF</constant></term> - <listitem><para>The passed file descriptor is not valid.</para> + <listitem><para>The passed file descriptor is not valid.</para></listitem> - <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> <varlistentry> <term><constant>-ENOSYS</constant></term> - <listitem><para><function>sd_event_add_inotify_fd()</function> was called without - <filename>/proc/</filename> mounted.</para> + <listitem> + <para><function>sd_event_add_inotify_fd()</function> or + <function>sd_event_source_get_inotify_path()</function> was called without + <filename>/proc/</filename> mounted.</para> + </listitem> - <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> </variablelist> @@ -219,28 +238,29 @@ <function>sd_event_add_inotify()</function>, and <function>sd_event_source_get_inotify_mask()</function> were added in version 239.</para> <para><function>sd_event_add_inotify_fd()</function> was added in version 250.</para> + <para><function>sd_event_source_get_inotify_path()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> |