chiark / gitweb /
service: add FailureAction= option
[elogind.git] / man / sd_bus_request_name.xml
index 6e61a88..9003f9f 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_bus_request_name">
+<refentry id="sd_bus_request_name" conditional="ENABLE_KDBUS">
 
         <refentryinfo>
                 <title>sd_bus_request_name</title>
@@ -56,7 +56,7 @@
                                 <funcdef>int <function>sd_bus_request_name</function></funcdef>
                                 <paramdef>sd_bus* <parameter>bus</parameter></paramdef>
                                 <paramdef>const char *<parameter>name</parameter></paramdef>
-                                <paramdef>unsigned <parameter>flags</parameter></paramdef>
+                                <paramdef>uint64_t <parameter>flags</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
@@ -64,8 +64,6 @@
                                 <paramdef>sd_bus* <parameter>bus</parameter></paramdef>
                                 <paramdef>const char *<parameter>name</parameter></paramdef>
                         </funcprototype>
-
-
                 </funcsynopsis>
         </refsynopsisdiv>
 
                                 <term><varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname></term>
 
                                 <listitem><para>After acquiring the
-                                name successuflly, permit other peers
+                                name successfully, permit other peers
                                 to take over the name when they try to
                                 acquire it with the
                                 <varname>SD_BUS_NAME_REPLACE_EXISTING</varname>
                                 flag set. If
                                 <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname>
-                                is not set on the original request
+                                is not set on the original request,
                                 such a request by other peers will be
                                 denied.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><varname>SD_BUS_NAME_REPLACE_EXISTING</varname></term>
 
-                                <listitem><para>Take over the name
-                                if it is already acquired by a another
-                                peer, and that other peer permitted
-                                taking it over by setting
+                                <listitem><para>Take over the name
+                                if it is already acquired by another
+                                peer, and that other peer has permitted
+                                takeover by setting
                                 <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname>
                                 while acquiring it.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>SD_BUS_NAME_DO_NOT_QUEUE</varname></term>
+                                <term><varname>SD_BUS_NAME_QUEUE</varname></term>
 
-                                <listitem><para>Do not queue name
-                                acquisition when the name is already
+                                <listitem><para>Queue the acquisition
+                                of the name when the name is already
                                 taken.</para></listitem>
                         </varlistentry>
                 </variablelist>
                 integer. On failure, these calls return a negative
                 errno-style error code.</para>
 
-                <para><function>sd_bus_request_name()</function> will
-                return 0 when the name is already taken by another
-                peer and the client has been added to the queue for
-                the name, unless
-                <varname>SD_BUS_NAME_DO_NOT_QUEUE</varname> has been
-                set. The caller can subscribe to
-                <literal>NameOwnerChanged</literal> signals to be
-                notified when the name is successfully
-                acquired. <function>sd_bus_request_name()</function> returns
-                &gt; 0 when the name has been
+                <para>If <varname>SD_BUS_NAME_QUEUE</varname> is
+                specified, <function>sd_bus_request_name()</function>
+                will return 0 when the name is already taken by
+                another peer and the client has been added to the
+                queue for the name. In that case, the caller can
+                subscribe to <literal>NameOwnerChanged</literal>
+                signals to be notified when the name is successfully
+                acquired. <function>sd_bus_request_name()</function>
+                returns &gt; 0 when the name has immediately been
                 acquired successfully.</para>
         </refsect1>
 
                         </varlistentry>
 
                         <varlistentry>
+                                <term><varname>-ESRCH</varname></term>
+
+                                <listitem><para>It was attempted to
+                                release a name that is currently not
+                                registered on the
+                                bus.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>-EADDRINUSE</varname></term>
+
+                                <listitem><para>It was attempted to
+                                release a name that is owned by a
+                                different peer on the
+                                bus.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
                                 <term><varname>-EINVAL</varname></term>
 
                                 <listitem><para>A specified parameter
 
                                 <listitem><para>The bus connection has
                                 been created in a different process
-                                than the current.</para></listitem>
+                                than the current one.</para></listitem>
                         </varlistentry>
                 </variablelist>
         </refsect1>
                 <title>Notes</title>
 
                 <para>The <function>sd_bus_acquire_name()</function>
-                and <function>sd_bus_release_bame()</function>
-                interfaces are available as shared library, which can
+                and <function>sd_bus_release_name()</function>
+                interfaces are available as shared library, which can
                 be compiled and linked to with the
-                <constant>libsystemd-bus</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>