add systemd support
[project/ubus.git] / libubus.h
index 13e4c03..a120eb6 100644 (file)
--- a/libubus.h
+++ b/libubus.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2011 Felix Fietkau <nbd@openwrt.org>
+ * Copyright (C) 2011-2012 Felix Fietkau <nbd@openwrt.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License version 2.1
@@ -11,6 +11,9 @@
  * GNU General Public License for more details.
  */
 
+#ifndef __LIBUBUS_H
+#define __LIBUBUS_H
+
 #include <libubox/avl.h>
 #include <libubox/list.h>
 #include <libubox/blobmsg.h>
@@ -19,6 +22,8 @@
 #include "ubusmsg.h"
 #include "ubus_common.h"
 
+#define UBUS_MAX_NOTIFY_PEERS  16
+
 struct ubus_context;
 struct ubus_msg_src;
 struct ubus_object;
@@ -26,7 +31,8 @@ struct ubus_request;
 struct ubus_request_data;
 struct ubus_object_data;
 struct ubus_event_handler;
-struct ubus_watch_object;
+struct ubus_subscriber;
+struct ubus_notify_request;
 
 typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
                                      struct ubus_object_data *obj,
@@ -34,13 +40,16 @@ typedef void (*ubus_lookup_handler_t)(struct ubus_context *ctx,
 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_state_handler_t)(struct ubus_context *ctx, struct ubus_object *obj);
+typedef void (*ubus_remove_handler_t)(struct ubus_context *ctx,
+                                     struct ubus_subscriber *obj, uint32_t id);
 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_watch_handler_t)(struct ubus_context *ctx, struct ubus_watch_object *w,
-                                    uint32_t id);
 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);
+typedef void (*ubus_notify_complete_handler_t)(struct ubus_notify_request *req,
+                                              int idx, int ret);
 
 #define UBUS_OBJECT_TYPE(_name, _methods)              \
        {                                               \
@@ -83,14 +92,18 @@ struct ubus_object {
        const char *path;
        struct ubus_object_type *type;
 
+       ubus_state_handler_t subscribe_cb;
+       bool has_subscribers;
+
        const struct ubus_method *methods;
        int n_methods;
 };
 
-struct ubus_watch_object {
+struct ubus_subscriber {
        struct ubus_object obj;
 
-       ubus_watch_handler_t cb;
+       ubus_handler_t cb;
+       ubus_remove_handler_t remove_cb;
 };
 
 struct ubus_event_handler {
@@ -107,7 +120,7 @@ struct ubus_context {
        struct uloop_fd sock;
 
        uint32_t local_id;
-       uint32_t request_seq;
+       uint16_t request_seq;
        int stack_depth;
 
        void (*connection_lost)(struct ubus_context *ctx);
@@ -128,20 +141,22 @@ struct ubus_object_data {
 struct ubus_request_data {
        uint32_t object;
        uint32_t peer;
-       uint32_t seq;
+       uint16_t seq;
+       bool deferred;
 };
 
 struct ubus_request {
        struct list_head list;
 
        struct list_head pending;
-       bool status_msg;
        int status_code;
+       bool status_msg;
        bool blocked;
        bool cancelled;
+       bool notify;
 
        uint32_t peer;
-       uint32_t seq;
+       uint16_t seq;
 
        ubus_data_handler_t raw_data_cb;
        ubus_data_handler_t data_cb;
@@ -151,8 +166,18 @@ struct ubus_request {
        void *priv;
 };
 
+struct ubus_notify_request {
+       struct ubus_request req;
+
+       ubus_notify_complete_handler_t status_cb;
+       ubus_notify_complete_handler_t complete_cb;
+
+       uint32_t pending;
+       uint32_t id[UBUS_MAX_NOTIFY_PEERS + 1];
+};
 
 struct ubus_context *ubus_connect(const char *path);
+int ubus_reconnect(struct ubus_context *ctx, const char *path);
 void ubus_free(struct ubus_context *ctx);
 
 const char *ubus_strerror(int error);
@@ -194,12 +219,10 @@ 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);
 
-/* add an object for watching other object state changes */
-int ubus_register_watch_object(struct ubus_context *ctx, struct ubus_watch_object *obj);
-
-int ubus_watch_object_add(struct ubus_context *ctx, struct ubus_watch_object *obj, uint32_t id);
-
-int ubus_watch_object_remove(struct ubus_context *ctx, struct ubus_watch_object *obj, uint32_t id);
+/* add a subscriber notifications from another object */
+int ubus_register_subscriber(struct ubus_context *ctx, struct ubus_subscriber *obj);
+int ubus_subscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
+int ubus_unsubscribe(struct ubus_context *ctx, struct ubus_subscriber *obj, uint32_t id);
 
 /* ----------- rpc ----------- */
 
@@ -216,6 +239,29 @@ int ubus_invoke_async(struct ubus_context *ctx, uint32_t obj, const char *method
 int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req,
                    struct blob_attr *msg);
 
+static inline void ubus_defer_request(struct ubus_context *ctx,
+                                     struct ubus_request_data *req,
+                                     struct ubus_request_data *new_req)
+{
+    memcpy(new_req, req, sizeof(*req));
+    req->deferred = true;
+}
+
+void ubus_complete_deferred_request(struct ubus_context *ctx,
+                                   struct ubus_request_data *req, int ret);
+
+/*
+ * send a notification to all subscribers of an object
+ * if timeout < 0, no reply is expected from subscribers
+ */
+int ubus_notify(struct ubus_context *ctx, struct ubus_object *obj,
+               const char *type, struct blob_attr *msg, int timeout);
+
+int ubus_notify_async(struct ubus_context *ctx, struct ubus_object *obj,
+                     const char *type, struct blob_attr *msg,
+                     struct ubus_notify_request *req);
+
+
 /* ----------- events ----------- */
 
 int ubus_send_event(struct ubus_context *ctx, const char *id,
@@ -230,3 +276,5 @@ static inline int ubus_unregister_event_handler(struct ubus_context *ctx,
 {
     return ubus_remove_object(ctx, &ev->obj);
 }
+
+#endif