1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* Copyright (C) 2016, 2017 "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
/* avoid inclusion of <json-c/json.h> */
struct json_object;
/*
* Interface for handling requests.
* It records the functions to be called for the request.
* Don't use this structure directly.
* Use the helper functions documented below.
*/
struct afb_event_itf
{
/* CAUTION: respect the order, add at the end */
int (*broadcast)(void *closure, struct json_object *obj);
int (*push)(void *closure, struct json_object *obj);
void (*unref)(void *closure);
const char *(*name)(void *closure);
void (*addref)(void *closure);
};
/*
* Describes the request of afb-daemon for bindings
*/
struct afb_event
{
const struct afb_event_itf *itf; /* the interface to use */
void *closure; /* the closure argument for functions of 'itf' */
};
/*
* Checks wether the 'event' is valid or not.
*
* Returns 0 if not valid or 1 if valid.
*/
static inline int afb_event_is_valid(struct afb_event event)
{
return !!event.itf;
}
/*
* Broadcasts widely the 'event' 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_event_broadcast(struct afb_event event, struct json_object *object)
{
return event.itf->broadcast(event.closure, object);
}
/*
* Pushes the 'event' 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_event_push(struct afb_event event, struct json_object *object)
{
return event.itf->push(event.closure, object);
}
/* OBSOLETE */
#define afb_event_drop afb_event_unref
/*
* Gets the name associated to the 'event'.
*/
static inline const char *afb_event_name(struct afb_event event)
{
return event.itf->name(event.closure);
}
/*
* Decrease the count of reference to 'event' and
* destroys the event when the reference count falls to zero.
*/
static inline void afb_event_unref(struct afb_event event)
{
event.itf->unref(event.closure);
}
/*
* remove one reference to the data associated to the 'event'
* After calling this function, the event
* MUST NOT BE USED ANYMORE.
*/
static inline void afb_event_addref(struct afb_event event)
{
event.itf->addref(event.closure);
}
|
