src/libsystemd-bus/sd-bus.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdbushfoo
   4 #define foosdbushfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2013 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <inttypes.h>
  26 #include <sys/types.h>
  27
  28 #include <sd-id128.h>
  29 #include "sd-bus-protocol.h"
  30
  31 /* TODO:
  32  * - implicitly add stub introspection calls
  33  * - server side
  34  * - allow installing match callbacks,
  35  *
  36  * Later:
  37  * - add page donation logic
  38  * - api for appending/reading fixed arrays
  39  * - merge busctl into systemctl or so?
  40  */
  41
  42 typedef struct sd_bus sd_bus;
  43 typedef struct sd_bus_message sd_bus_message;
  44
  45 typedef struct {
  46         const char *name;
  47         const char *message;
  48         int need_free;
  49 } sd_bus_error;
  50
  51 typedef int (*sd_message_handler_t)(sd_bus *bus, int ret, sd_bus_message *m, void *userdata);
  52
  53 /* Connections */
  54
  55 int sd_bus_open_system(sd_bus **ret);
  56 int sd_bus_open_user(sd_bus **ret);
  57
  58 int sd_bus_new(sd_bus **ret);
  59 int sd_bus_set_address(sd_bus *bus, const char *address);
  60 int sd_bus_set_fd(sd_bus *bus, int fd);
  61 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
  62 int sd_bus_set_bus_client(sd_bus *bus, int b);
  63 int sd_bus_set_negotiate_fds(sd_bus *bus, int b);
  64 int sd_bus_start(sd_bus *ret);
  65
  66 void sd_bus_close(sd_bus *bus);
  67
  68 sd_bus *sd_bus_ref(sd_bus *bus);
  69 sd_bus *sd_bus_unref(sd_bus *bus);
  70
  71 int sd_bus_is_open(sd_bus *bus);
  72 int sd_bus_can_send(sd_bus *bus, char type);
  73 int sd_bus_get_peer(sd_bus *bus, sd_id128_t *peer);
  74
  75 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  76 int sd_bus_send_with_reply(sd_bus *bus, sd_bus_message *m, sd_message_handler_t callback, void *userdata, uint64_t usec, uint64_t *serial);
  77 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
  78 int sd_bus_send_with_reply_and_block(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *error, sd_bus_message **r);
  79
  80 int sd_bus_get_fd(sd_bus *bus);
  81 int sd_bus_get_events(sd_bus *bus);
  82 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
  83 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
  84 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
  85 int sd_bus_flush(sd_bus *bus);
  86
  87 int sd_bus_add_filter(sd_bus *bus, sd_message_handler_t callback, void *userdata);
  88 int sd_bus_remove_filter(sd_bus *bus, sd_message_handler_t callback, void *userdata);
  89
  90 int sd_bus_add_object(sd_bus *bus, const char *path, sd_message_handler_t callback, void *userdata);
  91 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_message_handler_t callback, void *userdata);
  92
  93 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_message_handler_t callback, void *userdata);
  94 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_message_handler_t callback, void *userdata);
  95
  96 /* Message object */
  97
  98 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
  99 int sd_bus_message_new_method_call(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message **m);
 100 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
 101 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
 102
 103 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 104 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 105
 106 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 107 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
 108 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
 109 int sd_bus_message_get_no_reply(sd_bus_message *m);
 110
 111 const char *sd_bus_message_get_path(sd_bus_message *m);
 112 const char *sd_bus_message_get_interface(sd_bus_message *m);
 113 const char *sd_bus_message_get_member(sd_bus_message *m);
 114 const char *sd_bus_message_get_destination(sd_bus_message *m);
 115 const char *sd_bus_message_get_sender(sd_bus_message *m);
 116 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 117
 118 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 119 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 120 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 121 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 122 const char *sd_bus_message_get_label(sd_bus_message *m);
 123
 124 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 125 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 126 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 127
 128 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 129 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 130
 131 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 132 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 133 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 134 int sd_bus_message_close_container(sd_bus_message *m);
 135
 136 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 137 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 138 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 139 int sd_bus_message_exit_container(sd_bus_message *m);
 140 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 141 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 142
 143 /* Bus management */
 144
 145 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 146 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 147 int sd_bus_release_name(sd_bus *bus, const char *name);
 148 int sd_bus_list_names(sd_bus *bus, char ***l);
 149 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner);
 150 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 151 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 152 int sd_bus_add_match(sd_bus *bus, const char *match);
 153 int sd_bus_remove_match(sd_bus *bus, const char *match);
 154
 155 /* Error structures */
 156
 157 #define SD_BUS_ERROR_INIT {NULL, NULL, 0}
 158 #define SD_BUS_ERROR_INIT_CONST(name, message) {(name), (message), 0}
 159
 160 void sd_bus_error_free(sd_bus_error *e);
 161 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *format, ...);
 162 void sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 163 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 164 int sd_bus_error_is_set(const sd_bus_error *e);
 165 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 166
 167 #endif