man/sd_bus_message_append.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   Copyright © 2014 Zbigniew Jędrzejewski-Szmek
   9 -->
  10
  11 <refentry id="sd_bus_message_append"
  12           xmlns:xi="http://www.w3.org/2001/XInclude">
  13
  14   <refentryinfo>
  15     <title>sd_bus_message_append</title>
  16     <productname>systemd</productname>
  17   </refentryinfo>
  18
  19   <refmeta>
  20     <refentrytitle>sd_bus_message_append</refentrytitle>
  21     <manvolnum>3</manvolnum>
  22   </refmeta>
  23
  24   <refnamediv>
  25     <refname>sd_bus_message_append</refname>
  26     <refname>sd_bus_message_appendv</refname>
  27
  28     <refpurpose>Attach fields to a D-Bus message based on a type
  29     string</refpurpose>
  30   </refnamediv>
  31
  32   <refsynopsisdiv>
  33     <funcsynopsis>
  34       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
  35
  36       <funcprototype>
  37         <funcdef>int sd_bus_message_append</funcdef>
  38         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
  39         <paramdef>const char *<parameter>types</parameter></paramdef>
  40         <paramdef>…</paramdef>
  41       </funcprototype>
  42
  43       <funcprototype>
  44           <funcdef>int sd_bus_message_appendv</funcdef>
  45           <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
  46           <paramdef>const char *<parameter>types</parameter></paramdef>
  47           <paramdef>va_list <parameter>ap</parameter></paramdef>
  48       </funcprototype>
  49
  50     </funcsynopsis>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para>The <function>sd_bus_message_append()</function> function
  57     appends a sequence of fields to the D-Bus message object
  58     <parameter>m</parameter>. The type string
  59     <parameter>types</parameter> describes the types of the field
  60     arguments that follow. For each type specified in the type string,
  61     one or more arguments need to be specified, in the same order as
  62     declared in the type string.</para>
  63
  64     <para>The type string is composed of the elements shown in the
  65     table below. It contains zero or more single "complete types".
  66     Each complete type may be one of the basic types or a fully
  67     described container type. A container type may be a structure with
  68     the contained types, a variant, an array with its element type, or
  69     a dictionary entry with the contained types. The type string is
  70     <constant>NUL</constant>-terminated.</para>
  71
  72     <para>In case of a basic type, one argument of the corresponding
  73     type is expected.</para>
  74
  75     <para>A structure is denoted by a sequence of complete types
  76     between <literal>(</literal> and <literal>)</literal>. This
  77     sequence cannot be empty — it must contain at least one type.
  78     Arguments corresponding to this nested sequence follow the same
  79     rules as if they were not nested.</para>
  80
  81     <para>A variant is denoted by <literal>v</literal>. Corresponding
  82     arguments must begin with a type string denoting a complete type,
  83     and following that, arguments corresponding to the specified type.
  84     </para>
  85
  86     <para>An array is denoted by <literal>a</literal> followed by a
  87     complete type. Corresponding arguments must begin with the number of
  88     entries in the array, followed by the entries themselves,
  89     matching the element type of the array.</para>
  90
  91     <para>A dictionary is an array of dictionary entries, denoted by
  92     <literal>a</literal> followed by a pair of complete types between
  93     <literal>{</literal> and <literal>}</literal>. The first of those
  94     types must be a basic type. Corresponding arguments must begin
  95     with the number of dictionary entries, followed by a pair of
  96     values for each entry matching the element type of
  97     the dictionary entries.</para>
  98
  99     <para>The <function>sd_bus_message_appendv()</function> is equivalent to
 100     the function <function>sd_bus_message_append()</function>,
 101     except that it is called with a <literal>va_list</literal> instead of
 102     a variable number of arguments. This function does not call the
 103     <function>va_end()</function> macro. Because it invokes the
 104     <function>va_arg()</function> macro, the value of ap
 105     is undefined after the call.</para>
 106
 107     <para>For further details on the D-Bus type system, please consult
 108     the <ulink
 109     url="http://dbus.freedesktop.org/doc/dbus-specification.html#type-system">D-Bus
 110     Specification</ulink>.</para>
 111
 112     <table>
 113       <title>Item type specifiers</title>
 114
 115       <tgroup cols='5'>
 116         <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers'])//colspec" />
 117         <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers']//thead)" />
 118
 119         <tbody>
 120           <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers']//tbody/*)" />
 121
 122           <row>
 123             <entry><literal>a</literal></entry>
 124             <entry><constant>SD_BUS_TYPE_ARRAY</constant></entry>
 125             <entry>array</entry>
 126             <entry>determined by array type and size</entry>
 127             <entry>int, followed by array contents</entry>
 128           </row>
 129
 130           <row>
 131             <entry><literal>v</literal></entry>
 132             <entry><constant>SD_BUS_TYPE_VARIANT</constant></entry>
 133             <entry>variant</entry>
 134             <entry>determined by the type argument</entry>
 135             <entry>signature string, followed by variant contents</entry>
 136           </row>
 137
 138           <row>
 139             <entry><literal>(</literal></entry>
 140             <entry><constant>SD_BUS_TYPE_STRUCT_BEGIN</constant></entry>
 141             <entry>array start</entry>
 142             <entry morerows="1">determined by the nested types</entry>
 143             <entry morerows="1">structure contents</entry>
 144           </row>
 145           <row>
 146             <entry><literal>)</literal></entry>
 147             <entry><constant>SD_BUS_TYPE_STRUCT_END</constant></entry>
 148             <entry>array end</entry>
 149           </row>
 150
 151           <row>
 152             <entry><literal>{</literal></entry>
 153             <entry><constant>SD_BUS_TYPE_DICT_ENTRY_BEGIN</constant></entry>
 154             <entry>dictionary entry start</entry>
 155             <entry morerows="1">determined by the nested types</entry>
 156             <entry morerows="1">dictionary contents</entry>
 157           </row>
 158           <row>
 159             <entry><literal>}</literal></entry>
 160             <entry><constant>SD_BUS_TYPE_DICT_ENTRY_END</constant></entry>
 161             <entry>dictionary entry end</entry>
 162           </row>
 163        </tbody>
 164       </tgroup>
 165     </table>
 166
 167     <para>For types "s" and "g" (unicode string or signature), the pointer may be
 168     <constant>NULL</constant>, which is equivalent to an empty string. See
 169     <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 170     for the precise interpretation of those and other types.</para>
 171
 172   </refsect1>
 173
 174   <refsect1>
 175     <title>Types String Grammar</title>
 176
 177     <programlisting>types ::= complete_type*
 178 complete_type ::= basic_type | variant | structure | array | dictionary
 179 basic_type ::= "y" | "n" | "q" | "u" | "i" | "x" | "t" | "d" |
 180                "b" | "h" |
 181                "s" | "o" | "g"
 182 variant ::= "v"
 183 structure ::= "(" complete_type+ ")"
 184 array ::= "a" complete_type
 185 dictionary ::= "a" "{" basic_type complete_type "}"
 186 </programlisting>
 187   </refsect1>
 188
 189   <refsect1>
 190     <title>Examples</title>
 191
 192     <para>Append a single basic type (the string <literal>a string</literal>):
 193     </para>
 194
 195     <programlisting>sd_bus_message *m;
 196 …
 197 sd_bus_message_append(m, "s", "a string");</programlisting>
 198
 199     <para>Append all types of integers:</para>
 200
 201     <programlisting>uint8_t y = 1;
 202 int16_t n = 2;
 203 uint16_t q = 3;
 204 int32_t i = 4;
 205 uint32_t u = 5;
 206 int32_t x = 6;
 207 uint32_t t = 7;
 208 double d = 8.0;
 209 sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting>
 210
 211      <para>Append a structure composed of a string and a D-Bus path:</para>
 212
 213      <programlisting>sd_bus_message_append(m, "(so)", "a string", "/a/path");
 214 </programlisting>
 215
 216      <para>Append an array of UNIX file descriptors:</para>
 217
 218      <programlisting>sd_bus_message_append(m, "ah", 3, STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO);
 219 </programlisting>
 220
 221      <para>Append a variant, with the real type "g" (signature),
 222      and value "sdbusisgood":</para>
 223
 224      <programlisting>sd_bus_message_append(m, "v", "g", "sdbusisgood");</programlisting>
 225
 226      <para>Append a dictionary containing the mapping {1=>"a", 2=>"b", 3=>""}:
 227      </para>
 228
 229      <programlisting>sd_bus_message_append(m, "a{is}", 3, 1, "a", 2, "b", 3, NULL);
 230      </programlisting>
 231   </refsect1>
 232
 233   <refsect1>
 234     <title>Return Value</title>
 235
 236     <para>On success, these functions return 0 or a positive
 237     integer. On failure, these functions return a negative
 238     errno-style error code.</para>
 239   </refsect1>
 240
 241   <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
 242
 243   <xi:include href="libelogind-pkgconfig.xml" />
 244
 245   <refsect1>
 246     <title>See Also</title>
 247
 248     <para>
 249       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 250       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 251       <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 252       <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 253     </para>
 254   </refsect1>
 255
 256 </refentry>