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