src/systemd/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 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /* TODO:
  36  * - instead of adding in padding iovec when sending simply extend header buffer
  37  * - add page donation logic
  38  * - api for appending/reading fixed arrays
  39  * - merge busctl into systemctl or so?
  40  * - default policy (allow uid == 0 and our own uid)
  41  */
  42
  43 typedef struct sd_bus sd_bus;
  44 typedef struct sd_bus_message sd_bus_message;
  45
  46 typedef struct {
  47         const char *name;
  48         const char *message;
  49         int need_free;
  50 } sd_bus_error;
  51
  52 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, int ret, sd_bus_message *m, void *userdata);
  53
  54 /* Connections */
  55
  56 int sd_bus_open_system(sd_bus **ret);
  57 int sd_bus_open_user(sd_bus **ret);
  58
  59 int sd_bus_new(sd_bus **ret);
  60 int sd_bus_set_address(sd_bus *bus, const char *address);
  61 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
  62 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
  63 int sd_bus_set_bus_client(sd_bus *bus, int b);
  64 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id);
  65 int sd_bus_set_anonymous(sd_bus *bus, int b);
  66 int sd_bus_set_negotiate_fds(sd_bus *bus, int b);
  67 int sd_bus_start(sd_bus *ret);
  68
  69 void sd_bus_close(sd_bus *bus);
  70
  71 sd_bus *sd_bus_ref(sd_bus *bus);
  72 sd_bus *sd_bus_unref(sd_bus *bus);
  73
  74 int sd_bus_is_open(sd_bus *bus);
  75 int sd_bus_can_send(sd_bus *bus, char type);
  76 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *peer);
  77
  78 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  79 int sd_bus_send_with_reply(sd_bus *bus, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec, uint64_t *serial);
  80 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
  81 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);
  82
  83 int sd_bus_get_fd(sd_bus *bus);
  84 int sd_bus_get_events(sd_bus *bus);
  85 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
  86 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
  87 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
  88 int sd_bus_flush(sd_bus *bus);
  89
  90 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
  91 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata);
  92
  93 int sd_bus_add_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
  94 int sd_bus_remove_object(sd_bus *bus, const char *path, sd_bus_message_handler_t callback, void *userdata);
  95
  96 int sd_bus_add_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
  97 int sd_bus_remove_fallback(sd_bus *bus, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
  98
  99 int sd_bus_add_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 100 int sd_bus_remove_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata);
 101
 102 /* Message object */
 103
 104 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
 105 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);
 106 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
 107 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
 108
 109 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
 110 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
 111
 112 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
 113 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
 114 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
 115 int sd_bus_message_get_no_reply(sd_bus_message *m);
 116
 117 const char *sd_bus_message_get_path(sd_bus_message *m);
 118 const char *sd_bus_message_get_interface(sd_bus_message *m);
 119 const char *sd_bus_message_get_member(sd_bus_message *m);
 120 const char *sd_bus_message_get_destination(sd_bus_message *m);
 121 const char *sd_bus_message_get_sender(sd_bus_message *m);
 122 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 123
 124 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 125 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 126 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 127 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 128 int sd_bus_message_get_pid_starttime(sd_bus_message *m, uint64_t *usec);
 129 const char *sd_bus_message_get_label(sd_bus_message *m);
 130 int sd_bus_message_get_timestamp(sd_bus_message *m, uint64_t *usec);
 131
 132 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 133 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 134 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 135
 136 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 137 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 138
 139 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 140 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 141 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 142 int sd_bus_message_close_container(sd_bus_message *m);
 143
 144 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 145 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 146 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 147 int sd_bus_message_exit_container(sd_bus_message *m);
 148 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 149 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 150
 151 /* Convenience calls */
 152
 153 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
 154 int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *error, sd_bus_message **reply, const char *types, ...);
 155 int sd_bus_reply_method_return(sd_bus *bus, sd_bus_message *call, const char *types, ...);
 156 int sd_bus_reply_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e);
 157
 158 /* Bus management */
 159
 160 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
 161 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 162 int sd_bus_release_name(sd_bus *bus, const char *name);
 163 int sd_bus_list_names(sd_bus *bus, char ***l);
 164 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner);
 165 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 166 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 167
 168 /* Error structures */
 169
 170 #define SD_BUS_ERROR_NULL ((sd_bus_error) {NULL, NULL, 0})
 171 #define SD_BUS_ERROR_MAKE(name, message) ((sd_bus_error) {(name), (message), 0})
 172
 173 void sd_bus_error_free(sd_bus_error *e);
 174 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *format, ...);
 175 void sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 176 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 177 int sd_bus_error_is_set(const sd_bus_error *e);
 178 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif
 183
 184 #endif