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-bus-protocol.h"
  29
  30 /* TODO:
  31  *
  32  * - make unix fd passing work
  33  * - add page donation logic
  34  * - api for appending/reading fixed arrays
  35  * - always verify container depth
  36  * - handle NULL strings nicer when appending
  37  * - merge busctl into systemctl or so?
  38  * - add object handlers
  39  * - add peer message handlers
  40  * - verify object paths
  41  * - when reading a message, verify its size
  42  * - add limits to wqueue and rqueue alike
  43  */
  44
  45 typedef struct sd_bus sd_bus;
  46 typedef struct sd_bus_message sd_bus_message;
  47
  48 typedef struct {
  49         const char *name;
  50         const char *message;
  51         int need_free;
  52 } sd_bus_error;
  53
  54 typedef int (*sd_message_handler_t)(sd_bus *bus, int ret, sd_bus_message *m, void *userdata);
  55
  56 /* Connections */
  57
  58 int sd_bus_open_system(sd_bus **ret);
  59 int sd_bus_open_user(sd_bus **ret);
  60 int sd_bus_open_address(const char *address, sd_bus **ret);
  61 int sd_bus_open_fd(int fd, sd_bus **ret);
  62 void sd_bus_close(sd_bus *bus);
  63
  64 sd_bus *sd_bus_ref(sd_bus *bus);
  65 sd_bus *sd_bus_unref(sd_bus *bus);
  66
  67 int sd_bus_is_open(sd_bus *bus);
  68 int sd_bus_is_running(sd_bus *bus);
  69 int sd_bus_can_send(sd_bus *bus, char type);
  70
  71 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial);
  72 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);
  73 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial);
  74 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);
  75
  76 int sd_bus_get_fd(sd_bus *bus);
  77 int sd_bus_get_events(sd_bus *bus);
  78 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
  79 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
  80 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
  81 int sd_bus_flush(sd_bus *bus);
  82
  83 int sd_bus_add_filter(sd_bus *bus, sd_message_handler_t callback, void *userdata);
  84 int sd_bus_remove_filter(sd_bus *bus, sd_message_handler_t callback, void *userdata);
  85
  86 /* Message object */
  87
  88 int sd_bus_message_new_signal(sd_bus *bus, const char *path, const char *interface, const char *member, sd_bus_message **m);
  89 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);
  90 int sd_bus_message_new_method_return(sd_bus *bus, sd_bus_message *call, sd_bus_message **m);
  91 int sd_bus_message_new_method_error(sd_bus *bus, sd_bus_message *call, const sd_bus_error *e, sd_bus_message **m);
  92
  93 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
  94 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
  95
  96 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
  97 int sd_bus_message_get_serial(sd_bus_message *m, uint64_t *serial);
  98 int sd_bus_message_get_reply_serial(sd_bus_message *m, uint64_t *serial);
  99 int sd_bus_message_get_no_reply(sd_bus_message *m);
 100
 101 const char *sd_bus_message_get_path(sd_bus_message *m);
 102 const char *sd_bus_message_get_interface(sd_bus_message *m);
 103 const char *sd_bus_message_get_member(sd_bus_message *m);
 104 const char *sd_bus_message_get_destination(sd_bus_message *m);
 105 const char *sd_bus_message_get_sender(sd_bus_message *m);
 106 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
 107
 108 int sd_bus_message_get_uid(sd_bus_message *m, uid_t *uid);
 109 int sd_bus_message_get_gid(sd_bus_message *m, gid_t *gid);
 110 int sd_bus_message_get_pid(sd_bus_message *m, pid_t *pid);
 111 int sd_bus_message_get_tid(sd_bus_message *m, pid_t *tid);
 112
 113 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
 114 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
 115 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
 116
 117 int sd_bus_message_set_no_reply(sd_bus_message *m, int b);
 118 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
 119
 120 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
 121 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
 122 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
 123 int sd_bus_message_close_container(sd_bus_message *m);
 124
 125 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
 126 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
 127 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
 128 int sd_bus_message_exit_container(sd_bus_message *m);
 129 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
 130 int sd_bus_message_rewind(sd_bus_message *m, int complete);
 131
 132 /* Bus management */
 133
 134 const char *sd_bus_get_unique_name(sd_bus *bus);
 135 int sd_bus_request_name(sd_bus *bus, const char *name, int flags);
 136 int sd_bus_release_name(sd_bus *bus, const char *name);
 137 int sd_bus_list_names(sd_bus *bus, char ***l);
 138 int sd_bus_get_owner(sd_bus *bus, const char *name, char **owner);
 139 int sd_bus_get_owner_uid(sd_bus *bus, const char *name, uid_t *uid);
 140 int sd_bus_get_owner_pid(sd_bus *bus, const char *name, pid_t *pid);
 141 int sd_bus_add_match(sd_bus *bus, const char *match);
 142 int sd_bus_remove_match(sd_bus *bus, const char *match);
 143
 144 /* Error structures */
 145
 146 #define SD_BUS_ERROR_INIT {NULL, NULL, 0}
 147 #define SD_BUS_ERROR_INIT_CONST(name, message) {(name), (message), 0}
 148
 149 void sd_bus_error_free(sd_bus_error *e);
 150 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *format, ...);
 151 void sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
 152 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
 153 int sd_bus_error_is_set(const sd_bus_error *e);
 154 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
 155
 156 #endif