Generic event system. More...
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
| struct | ast_event_iterator |
| supposed to be an opaque type More... | |
Detailed Description
Generic event system.
Definition in file event_defs.h.
Enumeration Type Documentation
◆ ast_event_ie_pltype
| enum ast_event_ie_pltype |
Payload types for event information elements.
Definition at line 328 of file event_defs.h.
328 {
329 AST_EVENT_IE_PLTYPE_UNKNOWN = -1,
330 /*! Just check if it exists, not the value */
332 /*! Unsigned Integer (Can be used for signed, too ...) */
334 /*! String */
336 /*! Raw data, compared with memcmp */
338 /*! Bit flags (unsigned integer, compared using boolean logic) */
340};
◆ ast_event_ie_type
| enum ast_event_ie_type |
Event Information Element types.
Definition at line 68 of file event_defs.h.
68 {
69 /*! Used to terminate the arguments to event functions */
70 AST_EVENT_IE_END = -1,
71
72 /*!
73 * \brief Number of new messages
74 * Used by: AST_EVENT_MWI
75 * Payload type: UINT
76 */
77 AST_EVENT_IE_NEWMSGS = 0x0001,
78 /*!
79 * \brief Number of
80 * Used by: AST_EVENT_MWI
81 * Payload type: UINT
82 */
83 AST_EVENT_IE_OLDMSGS = 0x0002,
84 /*!
85 * \brief Mailbox name \verbatim (mailbox[@context]) \endverbatim
86 * Used by: AST_EVENT_MWI
87 * Payload type: STR
88 */
89 AST_EVENT_IE_MAILBOX = 0x0003,
90 /*!
91 * \brief Unique ID
92 * Used by: AST_EVENT_SUB, AST_EVENT_UNSUB
93 * Payload type: UINT
94 */
95 AST_EVENT_IE_UNIQUEID = 0x0004,
96 /*!
97 * \brief Event type
98 * Used by: AST_EVENT_SUB, AST_EVENT_UNSUB
99 * Payload type: UINT
100 */
101 AST_EVENT_IE_EVENTTYPE = 0x0005,
102 /*!
103 * \brief Hint that someone cares that an IE exists
104 * Used by: AST_EVENT_SUB
105 * Payload type: UINT (ast_event_ie_type)
106 */
107 AST_EVENT_IE_EXISTS = 0x0006,
108 /*!
109 * \brief Device Name
110 * Used by AST_EVENT_DEVICE_STATE_CHANGE
111 * Payload type: STR
112 */
113 AST_EVENT_IE_DEVICE = 0x0007,
114 /*!
115 * \brief Generic State IE
116 * Used by AST_EVENT_DEVICE_STATE_CHANGE
117 * Payload type: UINT
118 * The actual state values depend on the event which
119 * this IE is a part of.
120 */
121 AST_EVENT_IE_STATE = 0x0008,
122 /*!
123 * \brief Context IE
124 * Used by AST_EVENT_MWI
125 * Payload type: str
126 */
127 AST_EVENT_IE_CONTEXT = 0x0009,
128 /*!
129 * \brief Channel Event Type
130 * Used by: AST_EVENT_CEL
131 * Payload type: UINT
132 */
133 AST_EVENT_IE_CEL_EVENT_TYPE = 0x000a,
134 /*!
135 * \brief Channel Event Time (seconds)
136 * Used by: AST_EVENT_CEL
137 * Payload type: UINT
138 */
139 AST_EVENT_IE_CEL_EVENT_TIME = 0x000b,
140 /*!
141 * \brief Channel Event Time (micro-seconds)
142 * Used by: AST_EVENT_CEL
143 * Payload type: UINT
144 */
145 AST_EVENT_IE_CEL_EVENT_TIME_USEC = 0x000c,
146 /*!
147 * \brief Channel Event User Event Name
148 * Used by: AST_EVENT_CEL
149 * Payload type: STR
150 */
151 AST_EVENT_IE_CEL_USEREVENT_NAME = 0x000d,
152 /*!
153 * \brief Channel Event CID name
154 * Used by: AST_EVENT_CEL
155 * Payload type: STR
156 */
157 AST_EVENT_IE_CEL_CIDNAME = 0x000e,
158 /*!
159 * \brief Channel Event CID num
160 * Used by: AST_EVENT_CEL
161 * Payload type: STR
162 */
163 AST_EVENT_IE_CEL_CIDNUM = 0x000f,
164 /*!
165 * \brief Channel Event extension name
166 * Used by: AST_EVENT_CEL
167 * Payload type: STR
168 */
169 AST_EVENT_IE_CEL_EXTEN = 0x0010,
170 /*!
171 * \brief Channel Event context name
172 * Used by: AST_EVENT_CEL
173 * Payload type: STR
174 */
175 AST_EVENT_IE_CEL_CONTEXT = 0x0011,
176 /*!
177 * \brief Channel Event channel name
178 * Used by: AST_EVENT_CEL
179 * Payload type: STR
180 */
181 AST_EVENT_IE_CEL_CHANNAME = 0x0012,
182 /*!
183 * \brief Channel Event app name
184 * Used by: AST_EVENT_CEL
185 * Payload type: STR
186 */
187 AST_EVENT_IE_CEL_APPNAME = 0x0013,
188 /*!
189 * \brief Channel Event app args/data
190 * Used by: AST_EVENT_CEL
191 * Payload type: STR
192 */
193 AST_EVENT_IE_CEL_APPDATA = 0x0014,
194 /*!
195 * \brief Channel Event AMA flags
196 * Used by: AST_EVENT_CEL
197 * Payload type: UINT
198 */
199 AST_EVENT_IE_CEL_AMAFLAGS = 0x0015,
200 /*!
201 * \brief Channel Event AccountCode
202 * Used by: AST_EVENT_CEL
203 * Payload type: STR
204 */
205 AST_EVENT_IE_CEL_ACCTCODE = 0x0016,
206 /*!
207 * \brief Channel Event UniqueID
208 * Used by: AST_EVENT_CEL
209 * Payload type: STR
210 */
211 AST_EVENT_IE_CEL_UNIQUEID = 0x0017,
212 /*!
213 * \brief Channel Event Userfield
214 * Used by: AST_EVENT_CEL
215 * Payload type: STR
216 */
217 AST_EVENT_IE_CEL_USERFIELD = 0x0018,
218 /*!
219 * \brief Channel Event CID ANI field
220 * Used by: AST_EVENT_CEL
221 * Payload type: STR
222 */
223 AST_EVENT_IE_CEL_CIDANI = 0x0019,
224 /*!
225 * \brief Channel Event CID RDNIS field
226 * Used by: AST_EVENT_CEL
227 * Payload type: STR
228 */
229 AST_EVENT_IE_CEL_CIDRDNIS = 0x001a,
230 /*!
231 * \brief Channel Event CID dnid
232 * Used by: AST_EVENT_CEL
233 * Payload type: STR
234 */
235 AST_EVENT_IE_CEL_CIDDNID = 0x001b,
236 /*!
237 * \brief Channel Event Peer -- for Things involving multiple channels, like BRIDGE
238 * Used by: AST_EVENT_CEL
239 * Payload type: STR
240 */
241 AST_EVENT_IE_CEL_PEER = 0x001c,
242 /*!
243 * \brief Channel Event LinkedID
244 * Used by: AST_EVENT_CEL
245 * Payload type: STR
246 */
247 AST_EVENT_IE_CEL_LINKEDID = 0x001d,
248 /*!
249 * \brief Channel Event peeraccount
250 * Used by: AST_EVENT_CEL
251 * Payload type: STR
252 */
253 AST_EVENT_IE_CEL_PEERACCT = 0x001e,
254 /*!
255 * \brief Channel Event extra data
256 * Used by: AST_EVENT_CEL
257 * Payload type: STR
258 */
259 AST_EVENT_IE_CEL_EXTRA = 0x001f,
260 /*!
261 * \brief Description
262 * Used by: AST_EVENT_SUB, AST_EVENT_UNSUB
263 * Payload type: STR
264 */
265 AST_EVENT_IE_DESCRIPTION = 0x0020,
266 /*!
267 * \brief Entity ID
268 * Used by All events
269 * Payload type: RAW
270 * This IE indicates which server the event originated from
271 */
272 AST_EVENT_IE_EID = 0x0021,
273 AST_EVENT_IE_SECURITY_EVENT = 0x0022,
274 AST_EVENT_IE_EVENT_VERSION = 0x0023,
275 AST_EVENT_IE_SERVICE = 0x0024,
276 AST_EVENT_IE_MODULE = 0x0025,
277 AST_EVENT_IE_ACCOUNT_ID = 0x0026,
278 AST_EVENT_IE_SESSION_ID = 0x0027,
279 AST_EVENT_IE_SESSION_TV = 0x0028,
280 AST_EVENT_IE_ACL_NAME = 0x0029,
281 AST_EVENT_IE_LOCAL_ADDR = 0x002a,
282 AST_EVENT_IE_REMOTE_ADDR = 0x002b,
283 AST_EVENT_IE_EVENT_TV = 0x002c,
284 AST_EVENT_IE_REQUEST_TYPE = 0x002d,
285 AST_EVENT_IE_REQUEST_PARAMS = 0x002e,
286 AST_EVENT_IE_AUTH_METHOD = 0x002f,
287 AST_EVENT_IE_SEVERITY = 0x0030,
288 AST_EVENT_IE_EXPECTED_ADDR = 0x0031,
289 AST_EVENT_IE_CHALLENGE = 0x0032,
290 AST_EVENT_IE_RESPONSE = 0x0033,
291 AST_EVENT_IE_EXPECTED_RESPONSE = 0x0034,
292 AST_EVENT_IE_RECEIVED_CHALLENGE = 0x0035,
293 AST_EVENT_IE_RECEIVED_HASH = 0x0036,
294 AST_EVENT_IE_USING_PASSWORD = 0x0037,
295 AST_EVENT_IE_ATTEMPTED_TRANSPORT = 0x0038,
296 AST_EVENT_IE_PRESENCE_PROVIDER = 0x0039,
297 AST_EVENT_IE_PRESENCE_STATE = 0x003a,
298 AST_EVENT_IE_PRESENCE_SUBTYPE = 0x003b,
299 AST_EVENT_IE_PRESENCE_MESSAGE = 0x003c,
300
301 /*!
302 * \brief Event non-cacheability flag
303 * Used by: All events
304 * Payload type: UINT
305 */
306 AST_EVENT_IE_CACHABLE = 0x003d,
307
308 /*!
309 * \brief Cluster node ID
310 * Used by: Corosync
311 * Payload type: UINT
312 */
313 AST_EVENT_IE_NODE_ID = 0x003e,
314
315 /*!
316 * \brief Channel Event TenantID
317 * Used by: AST_EVENT_CEL
318 * Payload type: STR
319 */
320 AST_EVENT_IE_CEL_TENANTID = 0x003f,
321 /*! \brief Must be the last IE value +1 */
322 AST_EVENT_IE_TOTAL = 0x0040,
323};
@ AST_EVENT_IE_CEL_ACCTCODE
Channel Event AccountCode Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:205
@ AST_EVENT_IE_CEL_EXTRA
Channel Event extra data Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:259
@ AST_EVENT_IE_CEL_CONTEXT
Channel Event context name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:175
@ AST_EVENT_IE_CEL_PEERACCT
Channel Event peeraccount Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:253
@ AST_EVENT_IE_STATE
Generic State IE Used by AST_EVENT_DEVICE_STATE_CHANGE Payload type: UINT The actual state values dep...
Definition: event_defs.h:121
@ AST_EVENT_IE_CONTEXT
Context IE Used by AST_EVENT_MWI Payload type: str.
Definition: event_defs.h:127
@ AST_EVENT_IE_CEL_CIDRDNIS
Channel Event CID RDNIS field Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:229
@ AST_EVENT_IE_CEL_EVENT_TIME
Channel Event Time (seconds) Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:139
@ AST_EVENT_IE_UNIQUEID
Unique ID Used by: AST_EVENT_SUB, AST_EVENT_UNSUB Payload type: UINT.
Definition: event_defs.h:95
@ AST_EVENT_IE_CEL_CHANNAME
Channel Event channel name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:181
@ AST_EVENT_IE_CEL_CIDANI
Channel Event CID ANI field Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:223
@ AST_EVENT_IE_DEVICE
Device Name Used by AST_EVENT_DEVICE_STATE_CHANGE Payload type: STR.
Definition: event_defs.h:113
@ AST_EVENT_IE_CEL_CIDDNID
Channel Event CID dnid Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:235
@ AST_EVENT_IE_CEL_EXTEN
Channel Event extension name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:169
@ AST_EVENT_IE_EID
Entity ID Used by All events Payload type: RAW This IE indicates which server the event originated fr...
Definition: event_defs.h:272
@ AST_EVENT_IE_CEL_CIDNAME
Channel Event CID name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:157
@ AST_EVENT_IE_CEL_AMAFLAGS
Channel Event AMA flags Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:199
@ AST_EVENT_IE_CEL_USEREVENT_NAME
Channel Event User Event Name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:151
@ AST_EVENT_IE_CEL_TENANTID
Channel Event TenantID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:320
@ AST_EVENT_IE_CEL_LINKEDID
Channel Event LinkedID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:247
@ AST_EVENT_IE_CEL_EVENT_TIME_USEC
Channel Event Time (micro-seconds) Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:145
@ AST_EVENT_IE_CEL_EVENT_TYPE
Channel Event Type Used by: AST_EVENT_CEL Payload type: UINT.
Definition: event_defs.h:133
@ AST_EVENT_IE_EXISTS
Hint that someone cares that an IE exists Used by: AST_EVENT_SUB Payload type: UINT (ast_event_ie_typ...
Definition: event_defs.h:107
@ AST_EVENT_IE_CEL_UNIQUEID
Channel Event UniqueID Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:211
@ AST_EVENT_IE_CACHABLE
Event non-cacheability flag Used by: All events Payload type: UINT.
Definition: event_defs.h:306
@ AST_EVENT_IE_EVENTTYPE
Event type Used by: AST_EVENT_SUB, AST_EVENT_UNSUB Payload type: UINT.
Definition: event_defs.h:101
@ AST_EVENT_IE_CEL_APPNAME
Channel Event app name Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:187
@ AST_EVENT_IE_NODE_ID
Cluster node ID Used by: Corosync Payload type: UINT.
Definition: event_defs.h:313
@ AST_EVENT_IE_CEL_APPDATA
Channel Event app args/data Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:193
@ AST_EVENT_IE_DESCRIPTION
Description Used by: AST_EVENT_SUB, AST_EVENT_UNSUB Payload type: STR.
Definition: event_defs.h:265
@ AST_EVENT_IE_OLDMSGS
Number of Used by: AST_EVENT_MWI Payload type: UINT.
Definition: event_defs.h:83
@ AST_EVENT_IE_CEL_PEER
Channel Event Peer – for Things involving multiple channels, like BRIDGE Used by: AST_EVENT_CEL Paylo...
Definition: event_defs.h:241
@ AST_EVENT_IE_CEL_CIDNUM
Channel Event CID num Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:163
@ AST_EVENT_IE_CEL_USERFIELD
Channel Event Userfield Used by: AST_EVENT_CEL Payload type: STR.
Definition: event_defs.h:217
@ AST_EVENT_IE_NEWMSGS
Number of new messages Used by: AST_EVENT_MWI Payload type: UINT.
Definition: event_defs.h:77
◆ ast_event_subscriber_res
Results for checking for subscribers.
| Enumerator | |
|---|---|
| AST_EVENT_SUB_NONE | No subscribers exist |
| AST_EVENT_SUB_EXISTS | At least one subscriber exists |
Definition at line 343 of file event_defs.h.
343 {
344 /*! No subscribers exist */
345 AST_EVENT_SUB_NONE,
346 /*! At least one subscriber exists */
347 AST_EVENT_SUB_EXISTS,
348};
◆ ast_event_type
| enum ast_event_type |
| Enumerator | |
|---|---|
| AST_EVENT_ALL | Reserved to provide the ability to subscribe to all events. A specific event should never have a payload of 0. |
| AST_EVENT_CUSTOM | This event type is reserved for use by third-party modules to create custom events without having to modify this file.
|
| AST_EVENT_MWI | Voicemail message waiting indication |
| AST_EVENT_SUB | Someone has subscribed to events |
| AST_EVENT_UNSUB | Someone has unsubscribed from events |
| AST_EVENT_DEVICE_STATE | The aggregate state of a device across all servers configured to be a part of a device state cluster has changed. |
| AST_EVENT_DEVICE_STATE_CHANGE | The state of a device has changed on one server. This should not be used directly, in general. Use AST_EVENT_DEVICE_STATE instead. |
| AST_EVENT_CEL | Channel Event Logging events |
| AST_EVENT_SECURITY | A report of a security related event (see security_events.h) |
| AST_EVENT_NETWORK_CHANGE | Used by res_stun_monitor to alert listeners to an exernal network address change. |
| AST_EVENT_PRESENCE_STATE | The presence state for a presence provider |
| AST_EVENT_ACL_CHANGE | Used to alert listeners when a named ACL has changed. |
| AST_EVENT_PING | Send out a ping for debugging distributed events |
| AST_EVENT_CLUSTER_DISCOVERY | A cluster discovery message |
| AST_EVENT_TOTAL | Number of event types. This should be the last event type + 1 |
Definition at line 28 of file event_defs.h.
28 {
29 /*! Reserved to provide the ability to subscribe to all events. A specific
30 * event should never have a payload of 0. */
31 AST_EVENT_ALL = 0x00,
32 /*! This event type is reserved for use by third-party modules to create
33 * custom events without having to modify this file.
34 * \note There are no "custom" IE types, because IEs only have to be
35 * unique to the event itself, not necessarily across all events. */
36 AST_EVENT_CUSTOM = 0x01,
37 /*! Voicemail message waiting indication */
38 AST_EVENT_MWI = 0x02,
39 /*! Someone has subscribed to events */
40 AST_EVENT_SUB = 0x03,
41 /*! Someone has unsubscribed from events */
42 AST_EVENT_UNSUB = 0x04,
43 /*! The aggregate state of a device across all servers configured to be
44 * a part of a device state cluster has changed. */
45 AST_EVENT_DEVICE_STATE = 0x05,
46 /*! The state of a device has changed on _one_ server. This should not be used
47 * directly, in general. Use AST_EVENT_DEVICE_STATE instead. */
48 AST_EVENT_DEVICE_STATE_CHANGE = 0x06,
49 /*! Channel Event Logging events */
50 AST_EVENT_CEL = 0x07,
51 /*! A report of a security related event (see security_events.h) */
52 AST_EVENT_SECURITY = 0x08,
53 /*! Used by res_stun_monitor to alert listeners to an exernal network address change. */
54 AST_EVENT_NETWORK_CHANGE = 0x09,
55 /*! The presence state for a presence provider */
56 AST_EVENT_PRESENCE_STATE = 0x0a,
57 /*! Used to alert listeners when a named ACL has changed. */
58 AST_EVENT_ACL_CHANGE = 0x0b,
59 /*! Send out a ping for debugging distributed events */
60 AST_EVENT_PING = 0x0c,
61 /*! A cluster discovery message */
62 AST_EVENT_CLUSTER_DISCOVERY = 0x0d,
63 /*! Number of event types. This should be the last event type + 1 */
64 AST_EVENT_TOTAL = 0x0e,
65};
