man-pages/man3/sd_bus_message_set_expect_reply.3.html
2021-03-31 01:06:50 +01:00

193 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SD_BUS_MESSAGE_SET_EXPECT_REPLY</TITLE>
</HEAD><BODY>
<H1>SD_BUS_MESSAGE_SET_EXPECT_REPLY</H1>
Section: sd_bus_message_set_expect_reply (3)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
sd_bus_message_set_expect_reply, sd_bus_message_get_expect_reply, sd_bus_message_set_auto_start, sd_bus_message_get_auto_start - Set and query bus message metadata
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>
</B><PRE>
#include &lt;<A HREF="file:///usr/include/systemd/sd-bus.h">systemd/sd-bus.h</A>&gt;
</PRE>
<DL COMPACT>
<DT id="1">
<B>int sd_bus_message_set_expect_reply(sd_bus_message&nbsp;*</B><I>message</I><B>, int&nbsp;</B><I>b</I><B>);</B>
<DT id="2">
<B>int sd_bus_message_get_expect_reply(sd_bus_message&nbsp;*</B><I>message</I><B>);</B>
<DT id="3">
<B>int sd_bus_message_set_auto_start(sd_bus_message&nbsp;*</B><I>message</I><B>, int&nbsp;</B><I>b</I><B>);</B>
<DT id="4">
<B>int sd_bus_message_get_auto_start(sd_bus_message&nbsp;*</B><I>message</I><B>);</B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>sd_bus_message_set_expect_reply()</B>
<DD>sets or clears the
<B>NO_REPLY_EXPECTED</B>
flag on the message
<I>m</I>. This flag matters only for method call messages and is used to specify that no method return or error reply is expected. It is ignored for other types. Thus, for a method call message, calling
<P>
<DL COMPACT><DT id="5"><DD>
<PRE>
sd_bus_message_set_expect_reply(..., 0)
</PRE>
</DL>
<P>
sets the flag and suppresses the reply.
<P>
<B>sd_bus_message_get_expect_reply()</B>
checks if the
<B>NO_REPLY_EXPECTED</B>
flag is set on the message
<I>m</I>. It will return positive if it is not set, and zero if it is.
<P>
<B>sd_bus_message_set_auto_start()</B>
sets or clears the
<B>NO_AUTO_START</B>
flag on the message
<I>m</I>. When the flag is set the bus must not launch an owner for the destination name in response to this message. Calling
<P>
<DL COMPACT><DT id="6"><DD>
<PRE>
sd_bus_message_set_auto_start(..., 0)
</PRE>
</DL>
<P>
sets the flag.
<P>
<B>sd_bus_message_get_auto_start()</B>
checks if the
<B>NO_AUTO_START</B>
flag is set on the message
<I>m</I>. It will return positive if it is not set, and zero if it is.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<P>
On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style error code.
<A NAME="lbAF">&nbsp;</A>
<H3>Errors</H3>
<P>
Returned errors may indicate the following problems:
<P>
<B>-EINVAL</B>
<DL COMPACT><DT id="7"><DD>
The
<I>message</I>
parameter is
<B>NULL</B>.
</DL>
<P>
<B>-EPERM</B>
<DL COMPACT><DT id="8"><DD>
The message
<I>message</I>
is sealed when trying to set a flag.
<P>
The message
<I>message</I>
has wrong type.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>NOTES</H2>
<P>
These APIs are implemented as a shared library, which can be compiled and linked to with the
<B>libsystemd</B>&nbsp;<B><A HREF="/cgi-bin/man/man2html?1+pkg-config">pkg-config</A></B>(1)
file.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?3+sd-bus">sd-bus</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_set_description">sd_bus_set_description</A></B>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DL>
<DT id="13"><A HREF="#lbAF">Errors</A><DD>
</DL>
<DT id="14"><A HREF="#lbAG">NOTES</A><DD>
<DT id="15"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:55 GMT, March 31, 2021
</BODY>
</HTML>