1 #include <libubox/avl.h>
2 #include <libubox/list.h>
3 #include <libubox/blobmsg.h>
4 #include <libubox/uloop.h>
7 #include "ubus_common.h"
13 struct ubus_request_data
;
14 struct ubus_object_data
;
15 struct ubus_event_handler
;
17 typedef void (*ubus_lookup_handler_t
)(struct ubus_context
*ctx
,
18 struct ubus_object_data
*obj
,
20 typedef int (*ubus_handler_t
)(struct ubus_context
*ctx
, struct ubus_object
*obj
,
21 struct ubus_request_data
*req
,
22 const char *method
, struct blob_attr
*msg
);
23 typedef void (*ubus_event_handler_t
)(struct ubus_context
*ctx
, struct ubus_event_handler
*ev
,
24 const char *type
, struct blob_attr
*msg
);
25 typedef void (*ubus_data_handler_t
)(struct ubus_request
*req
,
26 int type
, struct blob_attr
*msg
);
27 typedef void (*ubus_complete_handler_t
)(struct ubus_request
*req
, int ret
);
30 #define UBUS_SIGNATURE(_type, _name) { .type = _type, .name = _name }
32 #define UBUS_METHOD_START(_name) UBUS_SIGNATURE(UBUS_SIGNATURE_METHOD, _name)
33 #define UBUS_METHOD_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
35 #define UBUS_FIELD(_type, _name) UBUS_SIGNATURE(BLOBMSG_TYPE_ ## _type, _name)
37 #define UBUS_ARRAY(_name) UBUS_FIELD(ARRAY, _name)
38 #define UBUS_ARRAY_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
40 #define UBUS_TABLE_START(_name) UBUS_FIELD(TABLE, _name)
41 #define UBUS_TABLE_END() UBUS_SIGNATURE(UBUS_SIGNATURE_END, NULL)
43 #define UBUS_OBJECT_TYPE(_name, _signature) \
47 .n_signature = ARRAY_SIZE(_signature), \
48 .signature = _signature \
51 struct ubus_signature
{
52 enum blobmsg_type type
;
56 struct ubus_object_type
{
60 const struct ubus_signature
*signature
;
65 ubus_handler_t handler
;
75 struct ubus_object_type
*type
;
77 const struct ubus_method
*methods
;
81 struct ubus_event_handler
{
82 struct ubus_object obj
;
84 ubus_event_handler_t cb
;
88 struct list_head requests
;
89 struct avl_tree objects
;
96 void (*connection_lost
)(struct ubus_context
*ctx
);
99 struct ubus_msghdr hdr
;
100 char data
[UBUS_MAX_MSGLEN
- sizeof(struct ubus_msghdr
)];
104 struct ubus_object_data
{
108 struct blob_attr
*signature
;
111 struct ubus_request_data
{
117 struct ubus_request
{
118 struct list_head list
;
120 struct list_head pending
;
129 ubus_data_handler_t raw_data_cb
;
130 ubus_data_handler_t data_cb
;
131 ubus_complete_handler_t complete_cb
;
133 struct ubus_context
*ctx
;
138 struct ubus_context
*ubus_connect(const char *path
);
139 void ubus_free(struct ubus_context
*ctx
);
141 const char *ubus_strerror(int error
);
143 static inline void ubus_add_uloop(struct ubus_context
*ctx
)
145 uloop_fd_add(&ctx
->sock
, ULOOP_EDGE_TRIGGER
| ULOOP_BLOCKING
| ULOOP_READ
);
148 /* ----------- raw request handling ----------- */
150 /* wait for a request to complete and return its status */
151 int ubus_complete_request(struct ubus_context
*ctx
, struct ubus_request
*req
);
153 /* complete a request asynchronously */
154 void ubus_complete_request_async(struct ubus_context
*ctx
,
155 struct ubus_request
*req
);
157 /* abort an asynchronous request */
158 void ubus_abort_request(struct ubus_context
*ctx
, struct ubus_request
*req
);
160 /* ----------- objects ----------- */
162 int ubus_lookup(struct ubus_context
*ctx
, const char *path
,
163 ubus_lookup_handler_t cb
, void *priv
);
165 int ubus_lookup_id(struct ubus_context
*ctx
, const char *path
, uint32_t *id
);
167 /* ----------- rpc ----------- */
169 /* invoke a method on a specific object */
170 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
171 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
);
173 /* asynchronous version of ubus_invoke() */
174 void ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
175 struct blob_attr
*msg
, struct ubus_request
*req
);
177 /* make an object visible to remote connections */
178 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
180 /* remove the object from the ubus connection */
181 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
183 /* send a reply to an incoming object method call */
184 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
185 struct blob_attr
*msg
);
187 /* ----------- events ----------- */
188 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
189 struct blob_attr
*data
);
191 int ubus_register_event_handler(struct ubus_context
*ctx
,
192 struct ubus_event_handler
*ev
,
193 const char *pattern
);
195 static inline int ubus_unregister_event_handler(struct ubus_context
*ctx
,
196 struct ubus_event_handler
*ev
)
198 return ubus_remove_object(ctx
, &ev
->obj
);