mirror of
https://github.com/systemd/systemd
synced 2024-07-22 10:44:58 +00:00
sd-bus: Add sd_bus_message_get_error/errno docs
This commit is contained in:
Daan De Meyer
Zbigniew Jędrzejewski-Szmek
parent
570f92c691
commit
0076098b0a
|
|
@ -291,7 +291,9 @@ manpages = [
|
|||
''],
|
||||
['sd_bus_message_get_type',
|
||||
'3',
|
||||
['sd_bus_message_is_method_call',
|
||||
['sd_bus_message_get_errno',
|
||||
'sd_bus_message_get_error',
|
||||
'sd_bus_message_is_method_call',
|
||||
'sd_bus_message_is_method_error',
|
||||
'sd_bus_message_is_signal'],
|
||||
''],
|
||||
|
|
|
|||
|
|
@ -99,6 +99,8 @@
|
|||
<citerefentry><refentrytitle>sd_bus_message_dump</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_get_property_trivial</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@
|
|||
|
||||
<refnamediv>
|
||||
<refname>sd_bus_message_get_type</refname>
|
||||
<refname>sd_bus_message_get_error</refname>
|
||||
<refname>sd_bus_message_get_errno</refname>
|
||||
<refname>sd_bus_message_is_signal</refname>
|
||||
<refname>sd_bus_message_is_method_call</refname>
|
||||
<refname>sd_bus_message_is_method_error</refname>
|
||||
|
|
@ -30,27 +32,37 @@
|
|||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_message_get_type</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
<paramdef>uint8_t *<parameter>type</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>sd_bus_error* <function>sd_bus_message_get_error</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_message_get_errno</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_message_is_signal</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
<paramdef>const char *<parameter>interface</parameter></paramdef>
|
||||
<paramdef>const char *<parameter>member</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_message_is_method_call</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
<paramdef>const char *<parameter>interface</parameter></paramdef>
|
||||
<paramdef>const char *<parameter>member</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_message_is_method_error</function></funcdef>
|
||||
<paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
|
||||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||||
<paramdef>const char *<parameter>name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
|
|
@ -62,40 +74,52 @@
|
|||
|
||||
<para><function>sd_bus_message_get_type()</function> returns the type of a message in the output
|
||||
parameter <parameter>type</parameter>, one of <constant>SD_BUS_MESSAGE_METHOD_CALL</constant>,
|
||||
<constant>SD_BUS_MESSAGE_METHOD_RETURN</constant>,
|
||||
<constant>SD_BUS_MESSAGE_METHOD_ERROR</constant>, <constant>SD_BUS_MESSAGE_SIGNAL</constant>.
|
||||
This type is either specified as a parameter when the message is created using
|
||||
<constant>SD_BUS_MESSAGE_METHOD_RETURN</constant>, <constant>SD_BUS_MESSAGE_METHOD_ERROR</constant>,
|
||||
<constant>SD_BUS_MESSAGE_SIGNAL</constant>. This type is either specified as a parameter when the message
|
||||
is created using
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
or is set automatically when the message is created using
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
and similar functions.
|
||||
and similar functions.</para>
|
||||
|
||||
<para><function>sd_bus_message_get_error()</function> returns the error stored in the message
|
||||
<parameter>m</parameter>, if there is any. Otherwise, it returns <constant>NULL</constant>.
|
||||
<function>sd_bus_message_get_errno()</function> returns the error stored in the message
|
||||
<parameter>m</parameter> as a positive errno-style value, if there is any. Otherwise, it returns zero.
|
||||
Errors are mapped to errno values according to the default and any additional registered error mappings.
|
||||
See <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
|
||||
<citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||||
</para>
|
||||
|
||||
<para><function>sd_bus_message_is_signal()</function> checks if message <parameter>m</parameter>
|
||||
is a signal message. If <parameter>interface</parameter> is non-null, it also checks if the
|
||||
message has the same interface set. If <parameter>member</parameter> is non-null, it also checks
|
||||
if the message has the same member set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>. It returns true when all checks pass.</para>
|
||||
<para><function>sd_bus_message_is_signal()</function> checks if message <parameter>m</parameter> is a
|
||||
signal message. If <parameter>interface</parameter> is non-null, it also checks if the message has the
|
||||
same interface set. If <parameter>member</parameter> is non-null, it also checks if the message has the
|
||||
same member set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||||
It returns true when all checks pass.</para>
|
||||
|
||||
<para><function>sd_bus_message_is_method_call()</function> checks if message <parameter>m</parameter>
|
||||
is a method call message. If <parameter>interface</parameter> is non-null, it also checks if the
|
||||
message has the same interface set. If <parameter>member</parameter> is non-null, it also checks
|
||||
if the message has the same member set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>. It returns true when all checks pass.</para>
|
||||
is a method call message. If <parameter>interface</parameter> is non-null, it also checks if the message
|
||||
has the same interface set. If <parameter>member</parameter> is non-null, it also checks if the message
|
||||
has the same member set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||||
It returns true when all checks pass.</para>
|
||||
|
||||
<para><function>sd_bus_message_is_method_error()</function> checks if message <parameter>m</parameter>
|
||||
is an error reply message. If <parameter>name</parameter> is non-null, it also checks if the
|
||||
message has the same error identifier set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>. It returns true when all checks pass.</para>
|
||||
</refsect1>
|
||||
is an error reply message. If <parameter>name</parameter> is non-null, it also checks if the message has
|
||||
the same error identifier set. Also see
|
||||
<citerefentry><refentrytitle>sd_bus_set_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||||
It returns true when all checks pass.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para>On success, those functions return 0 or a positive
|
||||
integer. On failure, it returns a negative errno-style error code.</para>
|
||||
<para>On success, these functions return a non-negative integer. On failure, they return a negative
|
||||
errno-style error code. <function>sd_bus_message_get_errno()</function> always returns a non-negative
|
||||
integer, even on failure.</para>
|
||||
|
||||
<refsect2>
|
||||
<title>Errors</title>
|
||||
|
|
@ -106,7 +130,7 @@
|
|||
<varlistentry>
|
||||
<term><constant>-EINVAL</constant></term>
|
||||
|
||||
<listitem><para>The <parameter>message</parameter> parameter or the output parameter are
|
||||
<listitem><para>The message parameter <parameter>m</parameter> or an output parameter is
|
||||
<constant>NULL</constant>.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
|
@ -122,7 +146,9 @@
|
|||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue