mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-13 20:23:48 +08:00
Code Issues Packages Projects Releases Wiki Activity
d3e85c9c81
systemd/man/sd_bus_message_get_cookie.xml

108 lines
3.7 KiB
XML
Raw Normal View History

man: add missing sd_bus_message_get_cookie man page fie
2013-12-26 01:05:48 +08:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-19 01:47:44 +08:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: add missing sd_bus_message_get_cookie man page fie
2013-12-26 01:05:48 +08:00
man: xinclude the generic text to talk about libsystemd pkgconfig The only difference is that functions are not individually listed by name, but that seems completely pointless, since all functions that are documented are always exported, so the generic text tells the user all she or he needs to know.
2018-06-06 17:59:04 +08:00
<refentry id="sd_bus_message_get_cookie"
xmlns:xi="http://www.w3.org/2001/XInclude">
man: add missing sd_bus_message_get_cookie man page fie
2013-12-26 01:05:48 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refentryinfo>
<title>sd_bus_message_get_cookie</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd_bus_message_get_cookie</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_bus_message_get_cookie</refname>
<refname>sd_bus_message_get_reply_cookie</refname>
<refpurpose>Returns the transaction cookie of a message</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>sd_bus_message_get_cookie</function></funcdef>
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
<paramdef>uint64_t *<parameter>cookie</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_message_get_reply_cookie</function></funcdef>
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
<paramdef>uint64_t *<parameter>cookie</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_bus_message_get_cookie()</function> returns the
transaction cookie of a message. The cookie uniquely identifies a
message within each bus peer, but is not globally unique. It is
assigned when a message is sent.</para>
<para><function>sd_bus_message_get_reply_cookie()</function>
returns the transaction cookie of the message the specified
message is a response to. When a reply message is generated for a
method call message, its cookie is copied over into this field.
Note that while every message that is transferred is identified by
a cookie, only response messages carry a reply cookie
field.</para>
<para>Both functions take a message object as first parameter and
a place to store the 64-bit cookie in.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>On success, these calls return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>On success, the cookie/reply cookie is returned in the specified 64-bit unsigned integer
variable.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<refsect2>
<title>Errors</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<para>Returned errors may indicate the following problems:</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<variablelist>
<varlistentry>
<term><constant>-EINVAL</constant></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para>A specified parameter is invalid.</para></listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<varlistentry>
<term><constant>-ENODATA</constant></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: make separate "Errors" sections subsection of "Return value" Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
2019-03-21 21:53:00 +08:00
<listitem><para>No cookie has been assigned to this message. This either indicates that the
message has not been sent yet and hence has no cookie assigned, or that the message is not a method
response message and hence carries a reply cookie field.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: xinclude the generic text to talk about libsystemd pkgconfig The only difference is that functions are not individually listed by name, but that seems completely pointless, since all functions that are documented are always exported, so the generic text tells the user all she or he needs to know.
2018-06-06 17:59:04 +08:00
<xi:include href="libsystemd-pkgconfig.xml" />
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>
man: add missing sd_bus_message_get_cookie man page fie
2013-12-26 01:05:48 +08:00
</refentry>
Reference in New Issue Copy Permalink