sd_bus_message_set_expect_reply(3) — Linux manual page



NAME         top

       sd_bus_message_set_expect_reply, sd_bus_message_get_expect_reply,
       sd_bus_message_set_auto_start, sd_bus_message_get_auto_start,
       sd_bus_message_get_allow_interactive_authorization - Set and query
       bus message metadata

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_set_expect_reply(sd_bus_message *message, int b);

       int sd_bus_message_get_expect_reply(sd_bus_message *message);

       int sd_bus_message_set_auto_start(sd_bus_message *message, int b);

       int sd_bus_message_get_auto_start(sd_bus_message *message);

                                                              sd_bus_message_set_allow_interactive_authorization(sd_bus_message *message,
                                                              int b);

                                                              sd_bus_message_get_allow_interactive_authorization(sd_bus_message *message);

DESCRIPTION         top

       sd_bus_message_set_expect_reply() sets or clears the
       NO_REPLY_EXPECTED flag on the message m. 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

           sd_bus_message_set_expect_reply(..., 0)

       sets the flag and suppresses the reply.

       sd_bus_message_get_expect_reply() checks if the NO_REPLY_EXPECTED
       flag is set on the message m. It will return positive if it is not
       set, and zero if it is.

       sd_bus_message_set_auto_start() sets or clears the NO_AUTO_START flag
       on the message m. When the flag is set, the bus must not launch an
       owner for the destination name in response to this message. Calling

           sd_bus_message_set_auto_start(..., 0)

       sets the flag.

       sd_bus_message_get_auto_start() checks if the NO_AUTO_START flag is
       set on the message m. It will return positive if it is not set, and
       zero if it is.

       sd_bus_message_set_allow_interactive_authorization() sets or clears
       the ALLOW_INTERACTIVE_AUTHORIZATION flag on the message m. Setting
       this flag informs the receiver that the caller is prepared to wait
       for interactive authorization via polkit or a similar framework. Note
       that setting this flag does not guarantee that the receiver will
       actually perform interactive authorization. Also, make sure to set a
       suitable message timeout when using this flag since interactive
       authorization could potentially take a long time as it depends on
       user input. If b is non-zero, the flag is set.

       sd_bus_message_get_allow_interactive_authorization() checks if the
       ALLOW_INTERACTIVE_AUTHORIZATION flag is set on the message m. It will
       return a positive integer if the flag is set. Otherwise, it returns

RETURN VALUE         top

       On success, these functions return a non-negative integer. On
       failure, they return a negative errno-style error code.

       Returned errors may indicate the following problems:

           The message parameter is NULL.

           The message message is sealed when trying to set a flag.

           The message message has wrong type.

NOTES         top

       These APIs are implemented as a shared library, which can be compiled
       and linked to with the libsystemd pkg-config(1) file.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_set_description(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 2020-06-09.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-06-09.)  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 245                               SD_BUS_MESSAGE_SET_EXPECT_REPLY(3)

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