chiark / gitweb /
Prep 229.9: Make all supportable API functions visible.
[elogind.git] / man / sd_is_fifo.xml
index 0f4f274f6fb22a3519080de9175db85e03476215..3dac5a9001da24b1061e4121ce82ebf8bcafa2f3 100644 (file)
@@ -3,22 +3,22 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
+  This file is part of elogind.
 
   Copyright 2010 Lennart Poettering
 
-  systemd is free software; you can redistribute it and/or modify it
+  elogind is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as published by
   the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.
 
-  systemd is distributed in the hope that it will be useful, but
+  elogind is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.
 
   You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+  along with elogind; If not, see <http://www.gnu.org/licenses/>.
 -->
 
 <refentry id="sd_is_fifo"
@@ -26,7 +26,7 @@
 
   <refentryinfo>
     <title>sd_is_fifo</title>
-    <productname>systemd</productname>
+    <productname>elogind</productname>
 
     <authorgroup>
       <author>
     <refname>sd_is_socket</refname>
     <refname>sd_is_socket_inet</refname>
     <refname>sd_is_socket_unix</refname>
-    <refname>sd_is_socket_sockaddr</refname>
-    <refname>sd_is_mq</refname>
     <refname>sd_is_special</refname>
     <refpurpose>Check the type of a file descriptor</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
     <funcsynopsis>
-      <funcsynopsisinfo>#include &lt;systemd/sd-daemon.h&gt;</funcsynopsisinfo>
+      <funcsynopsisinfo>#include &lt;elogind/sd-daemon.h&gt;</funcsynopsisinfo>
 
       <funcprototype>
         <funcdef>int <function>sd_is_fifo</function></funcdef>
         <paramdef>uint16_t <parameter>port</parameter></paramdef>
       </funcprototype>
 
-      <funcprototype>
-        <funcdef>int <function>sd_is_socket_sockaddr</function></funcdef>
-        <paramdef>int <parameter>fd</parameter></paramdef>
-        <paramdef>int <parameter>type</parameter></paramdef>
-        <paramdef>const struct sockaddr *<parameter>addr</parameter></paramdef>
-        <paramdef>unsigned <parameter>addr_len</parameter></paramdef>
-        <paramdef>int <parameter>listening</parameter></paramdef>
-      </funcprototype>
-
       <funcprototype>
         <funcdef>int <function>sd_is_socket_unix</function></funcdef>
         <paramdef>int <parameter>fd</parameter></paramdef>
         <paramdef>size_t <parameter>length</parameter></paramdef>
       </funcprototype>
 
-      <funcprototype>
-        <funcdef>int <function>sd_is_mq</function></funcdef>
-        <paramdef>int <parameter>fd</parameter></paramdef>
-        <paramdef>const char *<parameter>path</parameter></paramdef>
-      </funcprototype>
-
       <funcprototype>
         <funcdef>int <function>sd_is_special</function></funcdef>
         <paramdef>int <parameter>fd</parameter></paramdef>
     whether the specified file descriptor refers to a socket. If the
     <parameter>family</parameter> parameter is not
     <constant>AF_UNSPEC</constant>, it is checked whether the socket
-    is of the specified family (<constant>AF_UNIX</constant>,
-    <constant>AF_INET</constant>, …). If the <parameter>type</parameter>
-    parameter is not 0, it is checked whether the socket is of the
-    specified type (<constant>SOCK_STREAM</constant>,
-    <constant>SOCK_DGRAM</constant>, ). If the
+    is of the specified family (AF_UNIX, <constant>AF_INET</constant>,
+    ...). If the <parameter>type</parameter> parameter is not 0, it is
+    checked whether the socket is of the specified type
+    (<constant>SOCK_STREAM</constant>,
+    <constant>SOCK_DGRAM</constant>, ...). If the
     <parameter>listening</parameter> parameter is positive, it is
     checked whether the socket is in accepting mode, i.e.
     <function>listen()</function> has been called for it. If
     <constant>AF_UNSPEC</constant>, <constant>AF_INET</constant>, or
     <constant>AF_INET6</constant>.</para>
 
-    <para><function>sd_is_socket_sockaddr()</function> is similar to
-    <function>sd_is_socket_inet()</function>, but checks if the socket is bound to the
-    address specified by <parameter>addr</parameter>. The
-    <structfield>family</structfield> specified by <parameter>addr</parameter> must be
-    either <constant>AF_INET</constant> or <constant>AF_INET6</constant> and
-    <parameter>addr_len</parameter> must be large enough for that family. If
-    <parameter>addr</parameter> specifies a non-zero port, it is also checked if the
-    socket is bound to this port. In addition, for IPv6, if <parameter>addr</parameter>
-    specifies non-zero <structfield>sin6_flowinfo</structfield> or
-    <structfield>sin6_scope_id</structfield>, it is checked if the socket has the same
-    values.</para>
-
     <para><function>sd_is_socket_unix()</function> is similar to
     <function>sd_is_socket()</function> but optionally checks the
     <constant>AF_UNIX</constant> path the socket is bound to, unless
     <parameter>path</parameter> to the initial 0 byte of the socket
     address.</para>
 
-    <para><function>sd_is_mq()</function> may be called to check
-    whether the specified file descriptor refers to a POSIX message
-    queue. If the <parameter>path</parameter> parameter is not
-    <constant>NULL</constant>, it is checked whether the message queue
-    is bound to the specified name.</para>
-
     <para><function>sd_is_special()</function> may be called to check
     whether the specified file descriptor refers to a special file. If
     the <parameter>path</parameter> parameter is not
   <refsect1>
     <title>See Also</title>
     <para>
-      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>fifo</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-      <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
+      <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
     </para>
   </refsect1>