diff options
author | José Bollo <jose.bollo@iot.bzh> | 2018-04-09 18:16:07 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2018-06-15 17:57:36 +0200 |
commit | 4521c1e7ae5371ab9d639adc617d17fb4e8ded0c (patch) | |
tree | a8a1416a2d58c16ab3993c7e4dc405fc71daab6a /include/afb/afb-eventid.h | |
parent | 63682b4da9d3e892d1d0a671de860adc43068142 (diff) |
api-v3: First draft
This commit introduces the bindings v3 API for bindings.
The documentation has still to be improved and will come
very soon.
Change-Id: I8f9007370e29f671fdfd1da87fff7372a17db7af
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-eventid.h')
-rw-r--r-- | include/afb/afb-eventid.h | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/include/afb/afb-eventid.h b/include/afb/afb-eventid.h deleted file mode 100644 index 69d82a75..00000000 --- a/include/afb/afb-eventid.h +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (C) 2016, 2017, 2018 "IoT.bzh" - * Author: José Bollo <jose.bollo@iot.bzh> - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#pragma once - -#include "afb-eventid-itf.h" - -/* - * Broadcasts widely an event of 'eventid' with the data 'object'. - * 'object' can be NULL. - * - * For convenience, the function calls 'json_object_put' for 'object'. - * Thus, in the case where 'object' should remain available after - * the function returns, the function 'json_object_get' shall be used. - * - * Returns the count of clients that received the event. - */ -static inline int afb_eventid_broadcast( - struct afb_eventid *eventid, - struct json_object *object) -{ - return eventid->itf->broadcast(eventid, object); -} - -/* - * Pushes an event of 'eventid' with the data 'object' to its observers. - * 'object' can be NULL. - * - * For convenience, the function calls 'json_object_put' for 'object'. - * Thus, in the case where 'object' should remain available after - * the function returns, the function 'json_object_get' shall be used. - * - * Returns the count of clients that received the event. - */ -static inline int afb_eventid_push( - struct afb_eventid *eventid, - struct json_object *object) -{ - return eventid->itf->push(eventid, object); -} - -/* - * Gets the name associated to 'eventid'. - * The returned name can be used until call to 'afb_eventid_unref'. - */ -static inline const char *afb_eventid_name(struct afb_eventid *eventid) -{ - return eventid->itf->name(eventid); -} - -/* - * Decrease the count of references to 'eventid'. - * Call this function when the evenid is no more used. - * It destroys the eventid when the reference count falls to zero. - */ -static inline void afb_eventid_unref(struct afb_eventid *eventid) -{ - eventid->itf->unref(eventid); -} - -/* - * Increases the count of references to 'eventid' - */ -static inline struct afb_eventid *afb_eventid_addref( - struct afb_eventid *eventid) -{ - return eventid->itf->addref(eventid); -} - |