mirror of
https://github.com/systemd/systemd.git
synced 2024-10-27 18:55:40 +03:00
sd-event: document sd_event_source_set_io_fd_own()
With this we have 100% of the sd-event symbols documented again. Yay!
This commit is contained in:
parent
15723a1db0
commit
90b1fa59cf
@ -280,9 +280,11 @@ manpages = [
|
||||
'sd_event_source',
|
||||
'sd_event_source_get_io_events',
|
||||
'sd_event_source_get_io_fd',
|
||||
'sd_event_source_get_io_fd_own',
|
||||
'sd_event_source_get_io_revents',
|
||||
'sd_event_source_set_io_events',
|
||||
'sd_event_source_set_io_fd'],
|
||||
'sd_event_source_set_io_fd',
|
||||
'sd_event_source_set_io_fd_own'],
|
||||
''],
|
||||
['sd_event_add_signal',
|
||||
'3',
|
||||
|
@ -38,6 +38,8 @@
|
||||
<refname>sd_event_source_get_io_revents</refname>
|
||||
<refname>sd_event_source_get_io_fd</refname>
|
||||
<refname>sd_event_source_set_io_fd</refname>
|
||||
<refname>sd_event_source_get_io_fd_own</refname>
|
||||
<refname>sd_event_source_set_io_fd_own</refname>
|
||||
<refname>sd_event_source</refname>
|
||||
<refname>sd_event_io_handler_t</refname>
|
||||
|
||||
@ -97,6 +99,17 @@
|
||||
<paramdef>int <parameter>fd</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_event_source_get_io_fd_own</function></funcdef>
|
||||
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_event_source_set_io_fd_own</function></funcdef>
|
||||
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
|
||||
<paramdef>int <parameter>b</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
@ -212,6 +225,17 @@
|
||||
changes the UNIX file descriptor of an I/O event source created
|
||||
previously with <function>sd_event_add_io()</function>. It takes
|
||||
the event source object and the new file descriptor.</para>
|
||||
|
||||
<para><function>sd_event_source_set_io_fd_own()</function> controls whether the file descriptor of the event source
|
||||
shall be closed automatically when the event source is freed, i.e. whether it shall be considered 'owned' by the
|
||||
event source object. By default it is not closed automatically, and the application has to do this on its own. The
|
||||
<parameter>b</parameter> parameter is a boolean parameter: if zero, the file descriptor is not closed automatically
|
||||
when the event source is freed, otherwise it is closed.</para>
|
||||
|
||||
<para><function>sd_event_source_get_io_fd_own()</function> may be used to query the current setting of the file
|
||||
descriptor ownership boolean flag as set with <function>sd_event_source_set_io_fd_own()</function>. It returns
|
||||
positive if the file descriptor is closed automatically when the event source is destroyed, zero if not, and
|
||||
negative on error.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
|
Loading…
Reference in New Issue
Block a user