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
);
29 #define UBUS_OBJECT_TYPE(_name, _methods) \
33 .n_methods = ARRAY_SIZE(_methods), \
37 #define UBUS_METHOD(_name, _handler, _policy) \
40 .handler = _handler, \
42 .n_policy = ARRAY_SIZE(_policy) \
47 ubus_handler_t handler
;
49 const struct blobmsg_policy
*policy
;
53 struct ubus_object_type
{
57 const struct ubus_method
*methods
;
68 struct ubus_object_type
*type
;
70 const struct ubus_method
*methods
;
74 struct ubus_event_handler
{
75 struct ubus_object obj
;
77 ubus_event_handler_t cb
;
81 struct list_head requests
;
82 struct avl_tree objects
;
89 void (*connection_lost
)(struct ubus_context
*ctx
);
92 struct ubus_msghdr hdr
;
93 char data
[UBUS_MAX_MSGLEN
];
97 struct ubus_object_data
{
101 struct blob_attr
*signature
;
104 struct ubus_request_data
{
110 struct ubus_request
{
111 struct list_head list
;
113 struct list_head pending
;
122 ubus_data_handler_t raw_data_cb
;
123 ubus_data_handler_t data_cb
;
124 ubus_complete_handler_t complete_cb
;
126 struct ubus_context
*ctx
;
131 struct ubus_context
*ubus_connect(const char *path
);
132 void ubus_free(struct ubus_context
*ctx
);
134 const char *ubus_strerror(int error
);
136 static inline void ubus_add_uloop(struct ubus_context
*ctx
)
138 uloop_fd_add(&ctx
->sock
, ULOOP_EDGE_TRIGGER
| ULOOP_BLOCKING
| ULOOP_READ
);
141 /* call this for read events on ctx->sock.fd when not using uloop */
142 static inline void ubus_handle_event(struct ubus_context
*ctx
)
144 ctx
->sock
.cb(&ctx
->sock
, ULOOP_READ
);
147 /* ----------- raw request handling ----------- */
149 /* wait for a request to complete and return its status */
150 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 /* make an object visible to remote connections */
168 int ubus_add_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
170 /* remove the object from the ubus connection */
171 int ubus_remove_object(struct ubus_context
*ctx
, struct ubus_object
*obj
);
173 /* ----------- rpc ----------- */
175 /* invoke a method on a specific object */
176 int ubus_invoke(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
177 struct blob_attr
*msg
, ubus_data_handler_t cb
, void *priv
,
180 /* asynchronous version of ubus_invoke() */
181 int ubus_invoke_async(struct ubus_context
*ctx
, uint32_t obj
, const char *method
,
182 struct blob_attr
*msg
, struct ubus_request
*req
);
184 /* send a reply to an incoming object method call */
185 int ubus_send_reply(struct ubus_context
*ctx
, struct ubus_request_data
*req
,
186 struct blob_attr
*msg
);
188 /* ----------- events ----------- */
190 int ubus_send_event(struct ubus_context
*ctx
, const char *id
,
191 struct blob_attr
*data
);
193 int ubus_register_event_handler(struct ubus_context
*ctx
,
194 struct ubus_event_handler
*ev
,
195 const char *pattern
);
197 static inline int ubus_unregister_event_handler(struct ubus_context
*ctx
,
198 struct ubus_event_handler
*ev
)
200 return ubus_remove_object(ctx
, &ev
->obj
);