sd_bus_message_at_end(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | HISTORY | SEE ALSO | COLOPHON

SD_BUS_MESSAGE_AT_END(3)  sd_bus_message_at_end SD_BUS_MESSAGE_AT_END(3)

NAME         top

       sd_bus_message_at_end - Check if a message has been fully read

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_at_end(sd_bus_message *m, int complete);

DESCRIPTION         top

       sd_bus_message_at_end() returns whether all data from the
       currently opened container in m or all data from all containers
       in m has been read. If complete is zero, this function returns
       whether all data from the currently opened container has been
       read. If complete is non-zero, this function returns whether all
       data from all containers in m has been read.

RETURN VALUE         top

       If all data from all containers or the current container
       (depending on the value of complete) has been read,
       sd_bus_message_at_end() returns a positive integer. If there is
       still data left to be read, it returns zero. On failure, it
       returns a negative errno-style error code.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           The m parameter is NULL.

           Added in version 246.

       -EPERM
           The message is not sealed.

           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
       started.

HISTORY         top

       sd_bus_message_at_end() was added in version 246.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_read(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http:https://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http:https://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ 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
       [email protected]

systemd 255                                     SD_BUS_MESSAGE_AT_END(3)

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