sd_bus_message_seal(3) — Linux manual page


SD_BUS_MESSAGE_SEAL(3)     sd_bus_message_seal    SD_BUS_MESSAGE_SEAL(3)

NAME         top

       sd_bus_message_seal - Prepare a D-Bus message for transmission

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie,
                               uint64_t timeout_usec);

DESCRIPTION         top

       sd_bus_message_seal() finishes the message m and prepares it for
       transmission using sd_bus_send(3).  cookie specifies the
       identifier used to match the message reply to its corresponding
       request.  timeout_usec specifies the maximum time in microseconds
       to wait for a reply to arrive.

       Note that in most scenarios, it's not necessary to call this
       function directly.  sd_bus_call(3), sd_bus_call_async(3) and
       sd_bus_send(3) will seal any given messages if they have not been
       sealed yet.

RETURN VALUE         top

       On success, this function returns a non-negative integer. On
       failure, it returns a negative errno-style error code.

       Returned errors may indicate the following problems:

           The m parameter is NULL.

           Added in version 246.

           The D-Bus message m has open containers.

           Added in version 246.

           The D-Bus message m is a reply but its type signature does
           not match the return type signature of its corresponding
           member in the object vtable.

           Added in version 246.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been

HISTORY         top

       sd_bus_message_seal() was added in version 246.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_call(3), sd_bus_call_async(3),

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨⟩.  If you have
       a bug report for this manual page, see
       This page was obtained from the project's upstream Git repository
       ⟨⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

systemd 255                                       SD_BUS_MESSAGE_SEAL(3)

Pages that refer to this page: sd-bus(3)systemd.directives(7)systemd.index(7)