do not reverse method sorting order
[project/ubus.git] / libubus.h
index 9c07cae..b58a4dc 100644 (file)
--- a/libubus.h
+++ b/libubus.h
@@ -1,3 +1,4 @@
+#include <libubox/avl.h>
 #include <libubox/list.h>
 #include <libubox/blobmsg.h>
 #include <libubox/uloop.h>
@@ -5,14 +6,22 @@
 #include "ubusmsg.h"
 #include "ubus_common.h"
 
+struct ubus_context;
 struct ubus_msg_src;
 struct ubus_object;
 struct ubus_request;
 struct ubus_request_data;
-
-typedef void (*ubus_handler_t)(struct ubus_object *obj,
-                              struct ubus_request_data *req,
-                              const char *method, struct blob_attr *msg);
+struct ubus_object_data;
+struct ubus_event_handler;
+
+typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
+                                     struct ubus_object_data *obj,
+                                     void *priv);
+typedef int (*ubus_handler_t)(struct ubus_context *ctx, struct ubus_object *obj,
+                             struct ubus_request_data *req,
+                             const char *method, struct blob_attr *msg);
+typedef void (*ubus_event_handler_t)(struct ubus_context *ctx, struct ubus_event_handler *ev,
+                                    const char *type, struct blob_attr *msg);
 typedef void (*ubus_data_handler_t)(struct ubus_request *req,
                                    int type, struct blob_attr *msg);
 typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
@@ -40,7 +49,7 @@ typedef void (*ubus_complete_handler_t)(struct ubus_request *req, int ret);
        }
 
 struct ubus_signature {
-       enum blobmsg_type type;
+       int type;
        const char *name;
 };
 
@@ -51,30 +60,54 @@ struct ubus_object_type {
        const struct ubus_signature *signature;
 };
 
+struct ubus_method {
+       const char *name;
+       ubus_handler_t handler;
+};
+
 struct ubus_object {
+       struct avl_node avl;
+
        const char *name;
        uint32_t id;
 
        const char *path;
-       struct ubus_object *parent;
-
        struct ubus_object_type *type;
+
+       const struct ubus_method *methods;
+       int n_methods;
+};
+
+struct ubus_event_handler {
+       struct ubus_object obj;
+
+       ubus_event_handler_t cb;
 };
 
 struct ubus_context {
        struct list_head requests;
-       struct list_head objects;
+       struct avl_tree objects;
+
        struct uloop_fd sock;
 
        uint32_t local_id;
        uint32_t request_seq;
 
+       void (*connection_lost)(struct ubus_context *ctx);
+
        struct {
                struct ubus_msghdr hdr;
-               char data[UBUS_MAX_MSGLEN - sizeof(struct ubus_msghdr)];
+               char data[UBUS_MAX_MSGLEN];
        } msgbuf;
 };
 
+struct ubus_object_data {
+       uint32_t id;
+       uint32_t type_id;
+       const char *path;
+       struct blob_attr *signature;
+};
+
 struct ubus_request_data {
        uint32_t object;
        uint32_t peer;
@@ -93,31 +126,36 @@ struct ubus_request {
        uint32_t peer;
        uint32_t seq;
 
+       ubus_data_handler_t raw_data_cb;
        ubus_data_handler_t data_cb;
        ubus_complete_handler_t complete_cb;
 
+       struct ubus_context *ctx;
        void *priv;
 };
 
-#define BLOBMSG_END_TABLE      BLOBMSG_TYPE_UNSPEC
 
 struct ubus_context *ubus_connect(const char *path);
 void ubus_free(struct ubus_context *ctx);
 
 const char *ubus_strerror(int error);
 
-/* ----------- helpers for message handling ----------- */
+static inline void ubus_add_uloop(struct ubus_context *ctx)
+{
+       uloop_fd_add(&ctx->sock, ULOOP_EDGE_TRIGGER | ULOOP_BLOCKING | ULOOP_READ);
+}
 
-struct blob_attr **ubus_parse_msg(struct blob_attr *msg);
+/* call this for read events on ctx->sock.fd when not using uloop */
+static inline void ubus_handle_event(struct ubus_context *ctx)
+{
+       ctx->sock.cb(&ctx->sock, ULOOP_READ);
+}
 
 /* ----------- raw request handling ----------- */
 
-/* start a raw request */
-int ubus_start_request(struct ubus_context *ctx, struct ubus_request *req,
-                      struct blob_attr *msg, int cmd, uint32_t peer);
-
 /* wait for a request to complete and return its status */
-int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req);
+int ubus_complete_request(struct ubus_context *ctx, struct ubus_request *req,
+                         int timeout);
 
 /* complete a request asynchronously */
 void ubus_complete_request_async(struct ubus_context *ctx,
@@ -126,17 +164,45 @@ void ubus_complete_request_async(struct ubus_context *ctx,
 /* abort an asynchronous request */
 void ubus_abort_request(struct ubus_context *ctx, struct ubus_request *req);
 
+/* ----------- objects ----------- */
+
+int ubus_lookup(struct ubus_context *ctx, const char *path,
+               ubus_lookup_handler_t cb, void *priv);
+
+int ubus_lookup_id(struct ubus_context *ctx, const char *path, uint32_t *id);
+
+/* make an object visible to remote connections */
+int ubus_add_object(struct ubus_context *ctx, struct ubus_object *obj);
+
+/* remove the object from the ubus connection */
+int ubus_remove_object(struct ubus_context *ctx, struct ubus_object *obj);
+
 /* ----------- rpc ----------- */
 
 /* invoke a method on a specific object */
 int ubus_invoke(struct ubus_context *ctx, uint32_t obj, const char *method,
-                struct blob_attr *msg, ubus_data_handler_t cb, void *priv);
+               struct blob_attr *msg, ubus_data_handler_t cb, void *priv,
+               int timeout);
 
 /* asynchronous version of ubus_invoke() */
-void ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
-                       struct blob_attr *msg, struct ubus_request *req);
+int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method,
+                     struct blob_attr *msg, struct ubus_request *req);
 
-/* make an object visible to remote connections */
-int ubus_publish(struct ubus_context *ctx, struct ubus_object *obj);
+/* send a reply to an incoming object method call */
+int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
+                   struct blob_attr *msg);
+
+/* ----------- events ----------- */
+
+int ubus_send_event(struct ubus_context *ctx, const char *id,
+                   struct blob_attr *data);
 
+int ubus_register_event_handler(struct ubus_context *ctx,
+                               struct ubus_event_handler *ev,
+                               const char *pattern);
 
+static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
+                                               struct ubus_event_handler *ev)
+{
+    return ubus_remove_object(ctx, &ev->obj);
+}