blob: 477cead69e0898419c220a46ff23db8806f260ba (
plain)
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
|
Functions of class **afb_event**
==============================
## General functions
### afb_event_is_valid
```C
/**
* Checks whether the 'event' is valid or not.
*
* @param event the event to check
*
* @return 0 if not valid or 1 if valid.
*/
int afb_event_is_valid(
afb_event_t event);
```
### afb_event_name
```C
/**
* Gets the name associated to 'event'.
*
* @param event the event whose name is requested
*
* @return the name of the event
*
* The returned name can be used until call to 'afb_event_unref'.
* It shouldn't be freed.
*/
const char *afb_event_name(
afb_event_t event);
```
### afb_event_unref
```C
/**
* Decrease the count of references to 'event'.
* Call this function when the evenid is no more used.
* It destroys the event_x2 when the reference count falls to zero.
*
* @param event the event
*/
void afb_event_unref(
afb_event_t event);
```
### afb_event_addref
```C
/**
* Increases the count of references to 'event'
*
* @param event the event
*
* @return the event
*/
afb_event_t *afb_event_addref(
afb_event_t event);
```
## Pushing functions
### afb_event_broadcast
```C
/**
* Broadcasts widely an event of '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.
*
* @param event the event to broadcast
* @param object the companion object to associate to the broadcasted event (can be NULL)
*
* @return the count of clients that received the event.
*/
int afb_event_broadcast(
afb_event_t event,
struct json_object *object);
```
### afb_event_push
```C
/**
* Pushes an event of '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.
*
* @param event the event to push
* @param object the companion object to associate to the pushed event (can be NULL)
*
* @return the count of clients that received the event.
*/
int afb_event_push(
afb_event_t event,
struct json_object *object);
```
|
