#include "asterisk/event_defs.h"
Go to the source code of this file.
Typedefs | |
typedef void(* | ast_event_cb_t )(const struct ast_event *event, void *userdata) |
Subscriber event callback type. | |
Functions | |
int | ast_event_append_eid (struct ast_event **event) |
Append the global EID IE. | |
int | ast_event_append_ie_bitflags (struct ast_event **event, enum ast_event_ie_type ie_type, uint32_t bitflags) |
Append an information element that has a bitflags payload. | |
int | ast_event_append_ie_raw (struct ast_event **event, enum ast_event_ie_type ie_type, const void *data, size_t data_len) |
Append an information element that has a raw payload. | |
int | ast_event_append_ie_str (struct ast_event **event, enum ast_event_ie_type ie_type, const char *str) |
Append an information element that has a string payload. | |
int | ast_event_append_ie_uint (struct ast_event **event, enum ast_event_ie_type ie_type, uint32_t data) |
Append an information element that has an integer payload. | |
enum ast_event_subscriber_res | ast_event_check_subscriber (enum ast_event_type event_type,...) |
Check if subscribers exist. | |
void | ast_event_destroy (struct ast_event *event) |
Destroy an event. | |
void | ast_event_dump_cache (const struct ast_event_sub *event_sub) |
Dump the event cache for the subscriber. | |
struct ast_event * | ast_event_get_cached (enum ast_event_type,...) |
Retrieve an event from the cache. | |
uint32_t | ast_event_get_ie_bitflags (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the value of an information element that has a bitflags payload. | |
enum ast_event_ie_pltype | ast_event_get_ie_pltype (enum ast_event_ie_type ie_type) |
Get the payload type for a given information element type. | |
const void * | ast_event_get_ie_raw (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the value of an information element that has a raw payload. | |
uint16_t | ast_event_get_ie_raw_payload_len (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the length of the raw payload for a particular IE. | |
const char * | ast_event_get_ie_str (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the value of an information element that has a string payload. | |
uint32_t | ast_event_get_ie_str_hash (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the hash for the string payload of an IE. | |
const char * | ast_event_get_ie_type_name (enum ast_event_ie_type ie_type) |
Get the string representation of an information element type. | |
uint32_t | ast_event_get_ie_uint (const struct ast_event *event, enum ast_event_ie_type ie_type) |
Get the value of an information element that has an integer payload. | |
size_t | ast_event_get_size (const struct ast_event *event) |
Get the size of an event. | |
enum ast_event_type | ast_event_get_type (const struct ast_event *event) |
Get the type for an event. | |
const char * | ast_event_get_type_name (const struct ast_event *event) |
Get the string representation of the type of the given event. | |
uint32_t | ast_event_iterator_get_ie_bitflags (struct ast_event_iterator *iterator) |
Get the value of the current IE in the iterator as a bitflags payload. | |
void * | ast_event_iterator_get_ie_raw (struct ast_event_iterator *iterator) |
Get the value of the current IE in the iterator instance that has a raw payload. | |
uint16_t | ast_event_iterator_get_ie_raw_payload_len (struct ast_event_iterator *iterator) |
Get the length of the raw payload for the current IE for an iterator. | |
const char * | ast_event_iterator_get_ie_str (struct ast_event_iterator *iterator) |
Get the value of the current IE in the iterator as a string payload. | |
enum ast_event_ie_type | ast_event_iterator_get_ie_type (struct ast_event_iterator *iterator) |
Get the type of the current IE in the iterator instance. | |
uint32_t | ast_event_iterator_get_ie_uint (struct ast_event_iterator *iterator) |
Get the value of the current IE in the iterator as an integer payload. | |
int | ast_event_iterator_init (struct ast_event_iterator *iterator, const struct ast_event *event) |
Initialize an event iterator instance. | |
int | ast_event_iterator_next (struct ast_event_iterator *iterator) |
Move iterator instance to next IE. | |
size_t | ast_event_minimum_length (void) |
Get the minimum length of an ast_event. | |
struct ast_event * | ast_event_new (enum ast_event_type event_type,...) |
Create a new event. | |
int | ast_event_queue (struct ast_event *event) |
Queue an event. | |
int | ast_event_queue_and_cache (struct ast_event *event) |
Queue and cache an event. | |
void | ast_event_report_subs (const struct ast_event_sub *sub) |
Report current subscriptions to a subscription subscriber. | |
int | ast_event_str_to_event_type (const char *str, enum ast_event_type *event_type) |
Convert a string into an event type. | |
int | ast_event_str_to_ie_type (const char *str, enum ast_event_ie_type *ie_type) |
Convert a string to an IE type. | |
int | ast_event_sub_activate (struct ast_event_sub *sub) |
Activate a dynamically built subscription. | |
int | ast_event_sub_append_ie_bitflags (struct ast_event_sub *sub, enum ast_event_ie_type ie_type, uint32_t flags) |
Append a bitflags parameter to a subscription. | |
int | ast_event_sub_append_ie_exists (struct ast_event_sub *sub, enum ast_event_ie_type ie_type) |
Append an 'exists' parameter to a subscription. | |
int | ast_event_sub_append_ie_raw (struct ast_event_sub *sub, enum ast_event_ie_type ie_type, void *data, size_t raw_datalen) |
Append a raw parameter to a subscription. | |
int | ast_event_sub_append_ie_str (struct ast_event_sub *sub, enum ast_event_ie_type ie_type, const char *str) |
Append a string parameter to a subscription. | |
int | ast_event_sub_append_ie_uint (struct ast_event_sub *sub, enum ast_event_ie_type ie_type, uint32_t uint) |
Append a uint parameter to a subscription. | |
void | ast_event_sub_destroy (struct ast_event_sub *sub) |
Destroy an allocated subscription. | |
struct ast_event_sub * | ast_event_subscribe (enum ast_event_type event_type, ast_event_cb_t cb, const char *description, void *userdata,...) |
Subscribe to events. | |
struct ast_event_sub * | ast_event_subscribe_new (enum ast_event_type type, ast_event_cb_t cb, void *userdata) |
Allocate a subscription, but do not activate it. | |
const char * | ast_event_subscriber_get_description (struct ast_event_sub *sub) |
Get description for a subscription. | |
struct ast_event_sub * | ast_event_unsubscribe (struct ast_event_sub *event_sub) |
Un-subscribe from events. |
Definition in file event.h.
typedef void(* ast_event_cb_t)(const struct ast_event *event, void *userdata) |
Subscriber event callback type.
event | the event being passed to the subscriber | |
userdata | the data provider in the call to ast_event_subscribe() |
int ast_event_append_eid | ( | struct ast_event ** | event | ) |
Append the global EID IE.
event | the event to append IE to |
0 | success | |
-1 | failure |
Definition at line 1304 of file event.c.
References ast_eid_default, ast_event_append_ie_raw(), and AST_EVENT_IE_EID.
Referenced by ast_event_new().
01305 { 01306 return ast_event_append_ie_raw(event, AST_EVENT_IE_EID, 01307 &ast_eid_default, sizeof(ast_eid_default)); 01308 }
int ast_event_append_ie_bitflags | ( | struct ast_event ** | event, | |
enum ast_event_ie_type | ie_type, | |||
uint32_t | bitflags | |||
) |
Append an information element that has a bitflags payload.
event | the event that the IE will be appended to | |
ie_type | the type of IE to append | |
bitflags | the flags that are the payload of the IE |
0 | success | |
-1 | failure |
The pointer to the event will get updated with the new location for the event that now contains the appended information element. If the re-allocation of the memory for this event fails, it will be set to NULL.
Definition at line 1167 of file event.c.
References ast_event_append_ie_raw().
Referenced by ast_event_get_cached(), ast_event_new(), and gen_sub_event().
01169 { 01170 flags = htonl(flags); 01171 return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags)); 01172 }
int ast_event_append_ie_raw | ( | struct ast_event ** | event, | |
enum ast_event_ie_type | ie_type, | |||
const void * | data, | |||
size_t | data_len | |||
) |
Append an information element that has a raw payload.
event | the event that the IE will be appended to | |
ie_type | the type of IE to append | |
data | A pointer to the raw data for the payload of the IE | |
data_len | The amount of data to copy into the payload |
0 | success | |
-1 | failure |
The pointer to the event will get updated with the new location for the event that now contains the appended information element. If the re-allocation of the memory for this event fails, it will be set to NULL.
Definition at line 1174 of file event.c.
References ast_realloc, ast_event_ie::ie_payload, and ast_event_ie::ie_payload_len.
Referenced by ast_event_append_eid(), ast_event_append_ie_bitflags(), ast_event_append_ie_str(), ast_event_append_ie_uint(), ast_event_get_cached(), ast_event_new(), and gen_sub_event().
01176 { 01177 struct ast_event_ie *ie; 01178 unsigned int extra_len; 01179 uint16_t event_len; 01180 01181 event_len = ntohs((*event)->event_len); 01182 extra_len = sizeof(*ie) + data_len; 01183 01184 if (!(*event = ast_realloc(*event, event_len + extra_len))) { 01185 return -1; 01186 } 01187 01188 ie = (struct ast_event_ie *) ( ((char *) *event) + event_len ); 01189 ie->ie_type = htons(ie_type); 01190 ie->ie_payload_len = htons(data_len); 01191 memcpy(ie->ie_payload, data, data_len); 01192 01193 (*event)->event_len = htons(event_len + extra_len); 01194 01195 return 0; 01196 }
int ast_event_append_ie_str | ( | struct ast_event ** | event, | |
enum ast_event_ie_type | ie_type, | |||
const char * | str | |||
) |
Append an information element that has a string payload.
event | the event that the IE will be appended to | |
ie_type | the type of IE to append | |
str | The string for the payload of the IE |
0 | success | |
-1 | failure |
The pointer to the event will get updated with the new location for the event that now contains the appended information element. If the re-allocation of the memory for this event fails, it will be set to NULL.
Definition at line 1139 of file event.c.
References ast_alloca, ast_event_append_ie_raw(), AST_EVENT_IE_DEVICE, ast_str_hash(), ast_strdupa, ast_tech_to_upper(), ast_event_ie_str_payload::hash, and ast_event_ie_str_payload::str.
Referenced by add_ie(), add_ipv4_ie(), add_timeval_ie(), ast_event_get_cached(), ast_event_new(), and gen_sub_event().
01141 { 01142 struct ast_event_ie_str_payload *str_payload; 01143 size_t payload_len; 01144 01145 payload_len = sizeof(*str_payload) + strlen(str); 01146 str_payload = ast_alloca(payload_len); 01147 01148 strcpy(str_payload->str, str); 01149 if (ie_type == AST_EVENT_IE_DEVICE) { 01150 char *uppertech = ast_strdupa(str); 01151 ast_tech_to_upper(uppertech); 01152 str_payload->hash = ast_str_hash(uppertech); 01153 } else { 01154 str_payload->hash = ast_str_hash(str); 01155 } 01156 01157 return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len); 01158 }
int ast_event_append_ie_uint | ( | struct ast_event ** | event, | |
enum ast_event_ie_type | ie_type, | |||
uint32_t | data | |||
) |
Append an information element that has an integer payload.
event | the event that the IE will be appended to | |
ie_type | the type of IE to append | |
data | The integer for the payload of the IE |
0 | success | |
-1 | failure |
The pointer to the event will get updated with the new location for the event that now contains the appended information element. If the re-allocation of the memory for this event fails, it will be set to NULL.
Definition at line 1160 of file event.c.
References ast_event_append_ie_raw().
Referenced by add_ie(), ast_event_get_cached(), ast_event_new(), and gen_sub_event().
01162 { 01163 data = htonl(data); 01164 return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data)); 01165 }
enum ast_event_subscriber_res ast_event_check_subscriber | ( | enum ast_event_type | event_type, | |
... | ||||
) |
Check if subscribers exist.
event_type | This is the type of event that the caller would like to check for subscribers to. |
The rest of the arguments to this function specify additional parameters for checking for subscriptions to subsets of an event type. The arguments must in sets of:
<enum ast_event_ie_type>, [enum ast_event_ie_pltype, [payload] ]
and must end with AST_EVENT_IE_END.
If the ie_type specified is *not* AST_EVENT_IE_END, then it must be followed by a valid IE payload type. If the payload type specified is AST_EVENT_IE_PLTYPE_EXISTS, then the 3rd argument should not be provided. Otherwise, a payload must also be specified.
Example usage:
if (ast_event_check_subscriber(AST_EVENT_MWI, AST_EVENT_IE_MAILBOX, AST_EVENT_IE_PLTYPE_STR, mailbox, AST_EVENT_IE_END) == AST_EVENT_SUB_NONE) { return; }
This example will check if there are any subscribers to MWI events for the mailbox defined in the "mailbox" variable.
Definition at line 448 of file event.c.
References ARRAY_LEN, ast_alloca, AST_EVENT_ALL, AST_EVENT_IE_END, AST_EVENT_IE_PLTYPE_BITFLAGS, AST_EVENT_IE_PLTYPE_EXISTS, AST_EVENT_IE_PLTYPE_RAW, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_PLTYPE_UNKNOWN, AST_EVENT_SUB_EXISTS, AST_EVENT_SUB_NONE, ast_event_subs, AST_LIST_HEAD_NOLOCK_INIT_VALUE, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_log(), AST_RWDLLIST_RDLOCK, AST_RWDLLIST_TRAVERSE, AST_RWDLLIST_UNLOCK, AST_RWLIST_FIRST, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_ev_check_list::ie_vals, LOG_ERROR, LOG_WARNING, match_sub_ie_val_to_event(), ast_event_ie_val::payload, ast_event_ie_val::raw, ast_event_ie_val::raw_datalen, ast_event_ie_val::str, and ast_event_ie_val::uint.
Referenced by ast_event_queue(), ast_event_sub_activate(), and ast_event_unsubscribe().
00449 { 00450 va_list ap; 00451 enum ast_event_ie_type ie_type; 00452 enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE; 00453 struct ast_event_ie_val *ie_val; 00454 struct ast_event_sub *sub; 00455 struct ast_ev_check_list check_ie_vals = { 00456 .ie_vals = AST_LIST_HEAD_NOLOCK_INIT_VALUE 00457 }; 00458 const enum ast_event_type event_types[] = { type, AST_EVENT_ALL }; 00459 int i; 00460 int want_specific_event;/* TRUE if looking for subscribers wanting specific parameters. */ 00461 00462 if (type >= AST_EVENT_TOTAL) { 00463 ast_log(LOG_ERROR, "%u is an invalid type!\n", type); 00464 return res; 00465 } 00466 00467 want_specific_event = 0; 00468 va_start(ap, type); 00469 for (ie_type = va_arg(ap, enum ast_event_ie_type); 00470 ie_type != AST_EVENT_IE_END; 00471 ie_type = va_arg(ap, enum ast_event_ie_type)) 00472 { 00473 struct ast_event_ie_val *ie_value = ast_alloca(sizeof(*ie_value)); 00474 int insert = 0; 00475 00476 memset(ie_value, 0, sizeof(*ie_value)); 00477 ie_value->ie_type = ie_type; 00478 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype); 00479 switch (ie_value->ie_pltype) { 00480 case AST_EVENT_IE_PLTYPE_UINT: 00481 ie_value->payload.uint = va_arg(ap, uint32_t); 00482 insert = 1; 00483 break; 00484 case AST_EVENT_IE_PLTYPE_BITFLAGS: 00485 ie_value->payload.uint = va_arg(ap, uint32_t); 00486 insert = 1; 00487 break; 00488 case AST_EVENT_IE_PLTYPE_STR: 00489 ie_value->payload.str = va_arg(ap, const char *); 00490 insert = 1; 00491 break; 00492 case AST_EVENT_IE_PLTYPE_RAW: 00493 { 00494 void *data = va_arg(ap, void *); 00495 size_t datalen = va_arg(ap, size_t); 00496 00497 ie_value->payload.raw = ast_alloca(datalen); 00498 memcpy(ie_value->payload.raw, data, datalen); 00499 ie_value->raw_datalen = datalen; 00500 insert = 1; 00501 break; 00502 } 00503 case AST_EVENT_IE_PLTYPE_UNKNOWN: 00504 case AST_EVENT_IE_PLTYPE_EXISTS: 00505 /* Unsupported payload type. */ 00506 break; 00507 } 00508 00509 if (insert) { 00510 want_specific_event = 1; 00511 AST_LIST_INSERT_TAIL(&check_ie_vals.ie_vals, ie_value, entry); 00512 } else { 00513 ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype); 00514 } 00515 } 00516 va_end(ap); 00517 00518 for (i = 0; i < ARRAY_LEN(event_types); i++) { 00519 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]); 00520 if (want_specific_event) { 00521 AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) { 00522 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) { 00523 if (!match_sub_ie_val_to_event(ie_val, &check_ie_vals)) { 00524 /* The current subscription ie did not match an event ie. */ 00525 break; 00526 } 00527 } 00528 if (!ie_val) { 00529 /* Everything matched. A subscriber is looking for this event. */ 00530 break; 00531 } 00532 } 00533 } else { 00534 /* Just looking to see if there are ANY subscribers to the event type. */ 00535 sub = AST_RWLIST_FIRST(&ast_event_subs[event_types[i]]); 00536 } 00537 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]); 00538 if (sub) { 00539 break; 00540 } 00541 } 00542 00543 return sub ? AST_EVENT_SUB_EXISTS : AST_EVENT_SUB_NONE; 00544 }
void ast_event_destroy | ( | struct ast_event * | event | ) |
Destroy an event.
event | the event to destroy |
Definition at line 1310 of file event.c.
References ast_free.
Referenced by ast_cel_report_event(), ast_event_get_cached(), ast_event_queue(), ast_event_queue_and_cache(), ast_event_ref_destroy(), ast_event_report_subs(), ast_event_sub_activate(), ast_event_unsubscribe(), devstate_cached(), event_update_cache(), get_cached_mwi(), handle_security_event(), has_voicemail(), process_collection(), stun_monitor_request(), unistim_send_mwi_to_peer(), and update_registry().
01311 { 01312 ast_free(event); 01313 }
void ast_event_dump_cache | ( | const struct ast_event_sub * | event_sub | ) |
Dump the event cache for the subscriber.
Definition at line 654 of file event.c.
References ao2_callback, ast_event_cache, dump_cache_cb(), OBJ_NODATA, and ast_event_sub::type.
Referenced by add_publish_event(), aji_init_event_distribution(), ast_ais_evt_membership_changed(), and handle_devstate_change().
00655 { 00656 ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA, 00657 dump_cache_cb, (void *) event_sub); 00658 }
struct ast_event* ast_event_get_cached | ( | enum | ast_event_type, | |
... | ||||
) | [read] |
Retrieve an event from the cache.
ast_event_type | The type of event to retrieve from the cache |
The rest of the arguments to this function specify information elements to match for retrieving events from the cache. They are specified in the form:
<enum ast_event_ie_type>, [enum ast_event_ie_pltype, [payload] ]
and must end with AST_EVENT_IE_END.
If the ie_type specified is *not* AST_EVENT_IE_END, then it must be followed by a valid IE payload type. If the payload type specified is AST_EVENT_IE_PLTYPE_EXISTS, then the 3rd argument should not be provided. Otherwise, a payload must also be specified.
Example Usage:
event = ast_event_get_cached(AST_EVENT_MWI, AST_EVENT_IE_MAILBOX, AST_EVENT_IE_PLTYPE_STR, mailbox, AST_EVENT_IE_END);
This example will check for an MWI event in the cache that matches the specified mailbox. This would be the way to find out the last known state of a mailbox without having to poll the mailbox directly.
Definition at line 1338 of file event.c.
References ao2_find, ao2_ref, ast_event_append_ie_bitflags(), ast_event_append_ie_raw(), ast_event_append_ie_str(), ast_event_append_ie_uint(), ast_event_cache, ast_event_destroy(), ast_event_dup(), AST_EVENT_IE_END, AST_EVENT_IE_PLTYPE_BITFLAGS, AST_EVENT_IE_PLTYPE_EXISTS, AST_EVENT_IE_PLTYPE_RAW, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_PLTYPE_UNKNOWN, ast_event_new(), ast_log(), container, ast_event_ref::event, LOG_ERROR, LOG_WARNING, and OBJ_POINTER.
Referenced by devstate_cached(), get_cached_mwi(), has_voicemail(), process_collection(), unistim_send_mwi_to_peer(), and update_registry().
01339 { 01340 va_list ap; 01341 enum ast_event_ie_type ie_type; 01342 struct ast_event *dup_event = NULL; 01343 struct ast_event_ref *cached_event_ref; 01344 struct ast_event *cache_arg_event; 01345 struct ast_event_ref tmp_event_ref = { 01346 .event = NULL, 01347 }; 01348 struct ao2_container *container = NULL; 01349 01350 if (type >= AST_EVENT_TOTAL) { 01351 ast_log(LOG_ERROR, "%u is an invalid type!\n", type); 01352 return NULL; 01353 } 01354 01355 if (!(container = ast_event_cache[type].container)) { 01356 ast_log(LOG_ERROR, "%u is not a cached event type\n", type); 01357 return NULL; 01358 } 01359 01360 if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) { 01361 return NULL; 01362 } 01363 01364 va_start(ap, type); 01365 for (ie_type = va_arg(ap, enum ast_event_ie_type); 01366 ie_type != AST_EVENT_IE_END; 01367 ie_type = va_arg(ap, enum ast_event_ie_type)) 01368 { 01369 enum ast_event_ie_pltype ie_pltype; 01370 01371 ie_pltype = va_arg(ap, enum ast_event_ie_pltype); 01372 01373 switch (ie_pltype) { 01374 case AST_EVENT_IE_PLTYPE_UINT: 01375 ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t)); 01376 break; 01377 case AST_EVENT_IE_PLTYPE_BITFLAGS: 01378 ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t)); 01379 break; 01380 case AST_EVENT_IE_PLTYPE_STR: 01381 ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *)); 01382 break; 01383 case AST_EVENT_IE_PLTYPE_RAW: 01384 { 01385 void *data = va_arg(ap, void *); 01386 size_t datalen = va_arg(ap, size_t); 01387 ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen); 01388 break; 01389 } 01390 case AST_EVENT_IE_PLTYPE_EXISTS: 01391 ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n"); 01392 break; 01393 case AST_EVENT_IE_PLTYPE_UNKNOWN: 01394 break; 01395 } 01396 } 01397 va_end(ap); 01398 01399 tmp_event_ref.event = cache_arg_event; 01400 01401 cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER); 01402 01403 ast_event_destroy(cache_arg_event); 01404 cache_arg_event = NULL; 01405 01406 if (cached_event_ref) { 01407 dup_event = ast_event_dup(cached_event_ref->event); 01408 ao2_ref(cached_event_ref, -1); 01409 cached_event_ref = NULL; 01410 } 01411 01412 return dup_event; 01413 }
uint32_t ast_event_get_ie_bitflags | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the value of an information element that has a bitflags payload.
event | The event to get the IE from | |
ie_type | the type of information element to retrieve |
Definition at line 1084 of file event.c.
References ast_event_get_ie_raw(), and get_unaligned_uint32().
Referenced by append_ie(), and match_ie_val().
01085 { 01086 const uint32_t *ie_val; 01087 01088 ie_val = ast_event_get_ie_raw(event, ie_type); 01089 01090 return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0; 01091 }
enum ast_event_ie_pltype ast_event_get_ie_pltype | ( | enum ast_event_ie_type | ie_type | ) |
Get the payload type for a given information element type.
ie_type | the information element type to get the payload type of |
Definition at line 314 of file event.c.
References ARRAY_LEN, AST_EVENT_IE_PLTYPE_UNKNOWN, ast_log(), ie_maps, ie_map::ie_pltype, and LOG_ERROR.
Referenced by append_ie(), ast_event_cmp(), and event_dump_cli().
const void* ast_event_get_ie_raw | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the value of an information element that has a raw payload.
event | The event to get the IE from | |
ie_type | the type of information element to retrieve |
Definition at line 1111 of file event.c.
References ast_event_iterator_get_ie_raw(), ast_event_iterator_get_ie_type(), ast_event_iterator_init(), and ast_event_iterator_next().
Referenced by aji_devstate_cb(), aji_mwi_cb(), ast_event_cb(), ast_event_get_ie_bitflags(), ast_event_get_ie_str(), ast_event_get_ie_str_hash(), ast_event_get_ie_uint(), ast_event_new(), devstate_cache_cb(), devstate_change_collector_cb(), evt_event_deliver_cb(), ie_is_present(), and match_ie_val().
01112 { 01113 struct ast_event_iterator iterator; 01114 int res; 01115 01116 for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) { 01117 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) { 01118 return ast_event_iterator_get_ie_raw(&iterator); 01119 } 01120 } 01121 01122 return NULL; 01123 }
uint16_t ast_event_get_ie_raw_payload_len | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the length of the raw payload for a particular IE.
event | The event to get the IE payload length from | |
ie_type | the type of information element to get the length of |
Definition at line 1125 of file event.c.
References ast_event_iterator_get_ie_raw_payload_len(), ast_event_iterator_get_ie_type(), ast_event_iterator_init(), and ast_event_iterator_next().
Referenced by match_ie_val().
01126 { 01127 struct ast_event_iterator iterator; 01128 int res; 01129 01130 for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) { 01131 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) { 01132 return ast_event_iterator_get_ie_raw_payload_len(&iterator); 01133 } 01134 } 01135 01136 return 0; 01137 }
const char* ast_event_get_ie_str | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the value of an information element that has a string payload.
event | The event to get the IE from | |
ie_type | the type of information element to retrieve |
Definition at line 1102 of file event.c.
References ast_event_get_ie_raw(), and ast_event_ie_str_payload::str.
Referenced by aji_devstate_cb(), aji_mwi_cb(), append_ie(), ast_cel_fill_record(), ast_event_hash_devstate(), ast_event_hash_devstate_change(), ast_event_hash_mwi(), device_state_cb(), devstate_change_collector_cb(), generic_monitor_devstate_cb(), match_ie_val(), mwi_sub_event_cb(), and print_cel_sub().
01103 { 01104 const struct ast_event_ie_str_payload *str_payload; 01105 01106 str_payload = ast_event_get_ie_raw(event, ie_type); 01107 01108 return str_payload ? str_payload->str : NULL; 01109 }
uint32_t ast_event_get_ie_str_hash | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the hash for the string payload of an IE.
event | The event to get the IE from | |
ie_type | the type of information element to retrieve the hash for |
Definition at line 1093 of file event.c.
References ast_event_get_ie_raw(), and ast_event_ie_str_payload::hash.
Referenced by match_ie_val().
01094 { 01095 const struct ast_event_ie_str_payload *str_payload; 01096 01097 str_payload = ast_event_get_ie_raw(event, ie_type); 01098 01099 return str_payload ? str_payload->hash : 0; 01100 }
const char* ast_event_get_ie_type_name | ( | enum ast_event_ie_type | ie_type | ) |
Get the string representation of an information element type.
ie_type | the information element type to get the string representation of |
Definition at line 304 of file event.c.
References ARRAY_LEN, ast_log(), ie_maps, LOG_ERROR, and ie_map::name.
Referenced by append_ie(), dump_raw_ie(), event_dump_cache(), event_dump_cli(), and security_event_cb().
uint32_t ast_event_get_ie_uint | ( | const struct ast_event * | event, | |
enum ast_event_ie_type | ie_type | |||
) |
Get the value of an information element that has an integer payload.
event | The event to get the IE from | |
ie_type | the type of information element to retrieve |
Definition at line 1075 of file event.c.
References ast_event_get_ie_raw(), and get_unaligned_uint32().
Referenced by aji_devstate_cb(), aji_mwi_cb(), append_ie(), ast_cel_fill_record(), device_state_cb(), devstate_cache_cb(), devstate_cached(), devstate_change_collector_cb(), generic_agent_devstate_cb(), generic_monitor_devstate_cb(), get_cached_mwi(), has_voicemail(), match_ie_val(), mwi_event_cb(), mwi_sub_event_cb(), mwi_unsub_event_cb(), process_collection(), security_event_cb(), unistim_send_mwi_to_peer(), and update_registry().
01076 { 01077 const uint32_t *ie_val; 01078 01079 ie_val = ast_event_get_ie_raw(event, ie_type); 01080 01081 return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0; 01082 }
size_t ast_event_get_size | ( | const struct ast_event * | event | ) |
Get the size of an event.
event | the event to get the size of |
Definition at line 340 of file event.c.
References ast_event::event_len.
Referenced by ast_event_cb(), ast_event_dup(), and ast_event_iterator_init().
00341 { 00342 size_t res; 00343 00344 res = ntohs(event->event_len); 00345 00346 return res; 00347 }
enum ast_event_type ast_event_get_type | ( | const struct ast_event * | event | ) |
Get the type for an event.
event | the event to get the type for |
Definition at line 1070 of file event.c.
Referenced by ast_event_cb(), ast_event_cmp(), ast_event_get_type_name(), ast_event_hash(), ast_event_queue_and_cache(), mwi_sub_event_cb(), and mwi_unsub_event_cb().
const char* ast_event_get_type_name | ( | const struct ast_event * | event | ) |
Get the string representation of the type of the given event.
Definition at line 274 of file event.c.
References ARRAY_LEN, ast_event_get_type(), ast_log(), event_names, LOG_ERROR, and ast_event_sub::type.
Referenced by event_dump_cli().
00275 { 00276 enum ast_event_type type; 00277 00278 type = ast_event_get_type(event); 00279 00280 if (type < 0 || type >= ARRAY_LEN(event_names)) { 00281 ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type); 00282 return ""; 00283 } 00284 00285 return event_names[type]; 00286 }
uint32_t ast_event_iterator_get_ie_bitflags | ( | struct ast_event_iterator * | iterator | ) |
Get the value of the current IE in the iterator as a bitflags payload.
iterator | The iterator instance |
Definition at line 1046 of file event.c.
References get_unaligned_uint32(), ast_event_iterator::ie, and ast_event_ie::ie_payload.
Referenced by event_dump_cli().
01047 { 01048 return ntohl(get_unaligned_uint32(iterator->ie->ie_payload)); 01049 }
void* ast_event_iterator_get_ie_raw | ( | struct ast_event_iterator * | iterator | ) |
Get the value of the current IE in the iterator instance that has a raw payload.
iterator | The iterator instance |
Definition at line 1060 of file event.c.
References ast_event_iterator::ie, and ast_event_ie::ie_payload.
Referenced by ast_event_get_ie_raw(), and dump_raw_ie().
01061 { 01062 return iterator->ie->ie_payload; 01063 }
uint16_t ast_event_iterator_get_ie_raw_payload_len | ( | struct ast_event_iterator * | iterator | ) |
Get the length of the raw payload for the current IE for an iterator.
iterator | The IE iterator |
Definition at line 1065 of file event.c.
References ast_event_iterator::ie, and ast_event_ie::ie_payload_len.
Referenced by ast_event_get_ie_raw_payload_len().
01066 { 01067 return ntohs(iterator->ie->ie_payload_len); 01068 }
const char* ast_event_iterator_get_ie_str | ( | struct ast_event_iterator * | iterator | ) |
Get the value of the current IE in the iterator as a string payload.
iterator | The iterator instance |
Definition at line 1051 of file event.c.
References ast_event_iterator::ie, ast_event_ie::ie_payload, and ast_event_ie_str_payload::str.
Referenced by event_dump_cli().
01052 { 01053 const struct ast_event_ie_str_payload *str_payload; 01054 01055 str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload; 01056 01057 return str_payload ? str_payload->str : NULL; 01058 }
enum ast_event_ie_type ast_event_iterator_get_ie_type | ( | struct ast_event_iterator * | iterator | ) |
Get the type of the current IE in the iterator instance.
iterator | The iterator instance |
Definition at line 1036 of file event.c.
References ast_event_iterator::ie.
Referenced by ast_event_get_ie_raw(), ast_event_get_ie_raw_payload_len(), dump_raw_ie(), and event_dump_cli().
01037 { 01038 return ntohs(iterator->ie->ie_type); 01039 }
uint32_t ast_event_iterator_get_ie_uint | ( | struct ast_event_iterator * | iterator | ) |
Get the value of the current IE in the iterator as an integer payload.
iterator | The iterator instance |
Definition at line 1041 of file event.c.
References get_unaligned_uint32(), ast_event_iterator::ie, and ast_event_ie::ie_payload.
Referenced by event_dump_cli().
01042 { 01043 return ntohl(get_unaligned_uint32(iterator->ie->ie_payload)); 01044 }
int ast_event_iterator_init | ( | struct ast_event_iterator * | iterator, | |
const struct ast_event * | event | |||
) |
Initialize an event iterator instance.
iterator | The iterator instance to initialize | |
event | The event that will be iterated through |
0 | Success, there are IEs available to iterate | |
-1 | Failure, there are no IEs in the event to iterate |
Definition at line 1014 of file event.c.
References ast_event_get_size(), ast_event_iterator::event, ast_event_iterator::event_len, and ast_event_iterator::ie.
Referenced by ast_event_get_ie_raw(), ast_event_get_ie_raw_payload_len(), and event_dump_cli().
01015 { 01016 int res = 0; 01017 01018 iterator->event_len = ast_event_get_size(event); 01019 iterator->event = event; 01020 if (iterator->event_len >= sizeof(*event) + sizeof(struct ast_event_ie)) { 01021 iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) ); 01022 } else { 01023 iterator->ie = NULL; 01024 res = -1; 01025 } 01026 01027 return res; 01028 }
int ast_event_iterator_next | ( | struct ast_event_iterator * | iterator | ) |
Move iterator instance to next IE.
iterator | The iterator instance |
0 | on success | |
-1 | if end is reached |
Definition at line 1030 of file event.c.
References ast_event_iterator::event, ast_event_iterator::event_len, ast_event_iterator::ie, and ast_event_ie::ie_payload_len.
Referenced by ast_event_get_ie_raw(), ast_event_get_ie_raw_payload_len(), and event_dump_cli().
01031 { 01032 iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len)); 01033 return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0); 01034 }
size_t ast_event_minimum_length | ( | void | ) |
struct ast_event* ast_event_new | ( | enum ast_event_type | event_type, | |
... | ||||
) | [read] |
Create a new event.
event_type | The type of event to create |
The rest of the arguments to this function specify information elements to add to the event. They are specified in the form:
<enum ast_event_ie_type>, [enum ast_event_ie_pltype, [payload] ]
and must end with AST_EVENT_IE_END.
If the ie_type specified is *not* AST_EVENT_IE_END, then it must be followed by a valid IE payload type. The payload type, EXISTS, should not be used here because it makes no sense to do so. So, a payload must also be specified after the IE payload type.
Example usage:
if (!(event = ast_event_new(AST_EVENT_MWI, AST_EVENT_IE_MAILBOX, AST_EVENT_IE_PLTYPE_STR, mailbox, AST_EVENT_IE_NEWMSGS, AST_EVENT_IE_PLTYPE_UINT, new, AST_EVENT_IE_OLDMSGS, AST_EVENT_IE_PLTYPE_UINT, old, AST_EVENT_IE_END))) { return; }
This creates a MWI event with 3 information elements, a mailbox which is a string, and the number of new and old messages, specified as integers.
Definition at line 1198 of file event.c.
References ast_alloca, ast_calloc, ast_event_append_eid(), ast_event_append_ie_bitflags(), ast_event_append_ie_raw(), ast_event_append_ie_str(), ast_event_append_ie_uint(), ast_event_get_ie_raw(), AST_EVENT_IE_EID, AST_EVENT_IE_END, AST_EVENT_IE_PLTYPE_BITFLAGS, AST_EVENT_IE_PLTYPE_EXISTS, AST_EVENT_IE_PLTYPE_RAW, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_PLTYPE_UNKNOWN, AST_LIST_HEAD_NOLOCK_STATIC, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_log(), ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, LOG_WARNING, ast_event_ie_val::payload, ast_event_ie_val::raw, ast_event_ie_val::raw_datalen, ast_event_ie_val::str, and ast_event_ie_val::uint.
Referenced by aji_handle_pubsub_event(), alloc_event(), ast_cel_report_event(), ast_event_get_cached(), ast_event_unsubscribe(), devstate_event(), gen_sub_event(), handle_request_notify(), notify_message(), process_collection(), queue_mwi_event(), and stun_monitor_request().
01199 { 01200 va_list ap; 01201 struct ast_event *event; 01202 enum ast_event_ie_type ie_type; 01203 struct ast_event_ie_val *ie_val; 01204 int has_ie = 0; 01205 AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val); 01206 01207 /* Invalid type */ 01208 if (type >= AST_EVENT_TOTAL) { 01209 ast_log(LOG_WARNING, "Someone tried to create an event of invalid " 01210 "type '%d'!\n", type); 01211 return NULL; 01212 } 01213 01214 va_start(ap, type); 01215 for (ie_type = va_arg(ap, enum ast_event_ie_type); 01216 ie_type != AST_EVENT_IE_END; 01217 ie_type = va_arg(ap, enum ast_event_ie_type)) 01218 { 01219 struct ast_event_ie_val *ie_value = ast_alloca(sizeof(*ie_value)); 01220 int insert = 0; 01221 01222 memset(ie_value, 0, sizeof(*ie_value)); 01223 ie_value->ie_type = ie_type; 01224 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype); 01225 switch (ie_value->ie_pltype) { 01226 case AST_EVENT_IE_PLTYPE_UINT: 01227 ie_value->payload.uint = va_arg(ap, uint32_t); 01228 insert = 1; 01229 break; 01230 case AST_EVENT_IE_PLTYPE_BITFLAGS: 01231 ie_value->payload.uint = va_arg(ap, uint32_t); 01232 insert = 1; 01233 break; 01234 case AST_EVENT_IE_PLTYPE_STR: 01235 ie_value->payload.str = va_arg(ap, const char *); 01236 insert = 1; 01237 break; 01238 case AST_EVENT_IE_PLTYPE_RAW: 01239 { 01240 void *data = va_arg(ap, void *); 01241 size_t datalen = va_arg(ap, size_t); 01242 ie_value->payload.raw = ast_alloca(datalen); 01243 memcpy(ie_value->payload.raw, data, datalen); 01244 ie_value->raw_datalen = datalen; 01245 insert = 1; 01246 break; 01247 } 01248 case AST_EVENT_IE_PLTYPE_UNKNOWN: 01249 case AST_EVENT_IE_PLTYPE_EXISTS: 01250 break; 01251 } 01252 01253 if (insert) { 01254 AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry); 01255 has_ie = 1; 01256 } else { 01257 ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype); 01258 } 01259 } 01260 va_end(ap); 01261 01262 if (!(event = ast_calloc(1, sizeof(*event)))) { 01263 return NULL; 01264 } 01265 01266 event->type = htons(type); 01267 event->event_len = htons(sizeof(*event)); 01268 01269 AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) { 01270 switch (ie_val->ie_pltype) { 01271 case AST_EVENT_IE_PLTYPE_STR: 01272 ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str); 01273 break; 01274 case AST_EVENT_IE_PLTYPE_UINT: 01275 ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint); 01276 break; 01277 case AST_EVENT_IE_PLTYPE_BITFLAGS: 01278 ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint); 01279 break; 01280 case AST_EVENT_IE_PLTYPE_RAW: 01281 ast_event_append_ie_raw(&event, ie_val->ie_type, 01282 ie_val->payload.raw, ie_val->raw_datalen); 01283 break; 01284 case AST_EVENT_IE_PLTYPE_EXISTS: 01285 case AST_EVENT_IE_PLTYPE_UNKNOWN: 01286 break; 01287 } 01288 01289 /* realloc inside one of the append functions failed */ 01290 if (!event) { 01291 return NULL; 01292 } 01293 } 01294 01295 if (has_ie && !ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) { 01296 /* If the event is originating on this server, add the server's 01297 * entity ID to the event. */ 01298 ast_event_append_eid(&event); 01299 } 01300 01301 return event; 01302 }
int ast_event_queue | ( | struct ast_event * | event | ) |
Queue an event.
event | the event to be queued |
zero | success | |
non-zero | failure. Note that the caller of this function is responsible for destroying the event in the case of a failure. |
This function queues an event to be dispatched to all of the appropriate subscribers. This function will not block while the event is being dispatched because the event is queued up for a dispatching thread to handle.
Definition at line 1513 of file event.c.
References alloc_event_ref(), ao2_ref, ast_event_check_subscriber(), ast_event_destroy(), AST_EVENT_IE_END, AST_EVENT_SUB_NONE, ast_log(), ast_taskprocessor_push(), ast_event_ref::event, handle_event(), and LOG_WARNING.
Referenced by aji_handle_pubsub_event(), ast_cel_report_event(), ast_event_queue_and_cache(), ast_event_sub_activate(), ast_event_unsubscribe(), devstate_event(), handle_security_event(), process_collection(), and stun_monitor_request().
01514 { 01515 struct ast_event_ref *event_ref; 01516 uint16_t host_event_type; 01517 int res; 01518 01519 host_event_type = ntohs(event->type); 01520 01521 /* Invalid type */ 01522 if (host_event_type >= AST_EVENT_TOTAL) { 01523 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid " 01524 "type '%d'!\n", host_event_type); 01525 return -1; 01526 } 01527 01528 /* If nobody has subscribed to this event type, throw it away now */ 01529 if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END) 01530 == AST_EVENT_SUB_NONE) { 01531 ast_event_destroy(event); 01532 return 0; 01533 } 01534 01535 if (!(event_ref = alloc_event_ref())) { 01536 return -1; 01537 } 01538 01539 event_ref->event = event; 01540 01541 res = ast_taskprocessor_push(event_dispatcher, handle_event, event_ref); 01542 if (res) { 01543 event_ref->event = NULL; 01544 ao2_ref(event_ref, -1); 01545 } 01546 return res; 01547 }
int ast_event_queue_and_cache | ( | struct ast_event * | event | ) |
Queue and cache an event.
event | the event to be queued and cached |
The purpose of caching events is so that the core can retain the last known information for events that represent some sort of state. That way, when code needs to find out the current state, it can query the cache.
The event API already knows which events can be cached and how to cache them.
0 | success | |
non-zero | failure. |
Definition at line 1461 of file event.c.
References ast_event_cache, ast_event_destroy(), ast_event_get_type(), ast_event_queue(), ast_log(), container, event_update_cache(), and LOG_WARNING.
Referenced by aji_handle_pubsub_event(), devstate_event(), handle_request_notify(), notify_message(), process_collection(), queue_event(), and queue_mwi_event().
01462 { 01463 struct ao2_container *container; 01464 01465 container = ast_event_cache[ast_event_get_type(event)].container; 01466 if (!container) { 01467 ast_log(LOG_WARNING, "cache requested for non-cached event type\n"); 01468 } else { 01469 event_update_cache(container, event); 01470 } 01471 01472 if (ast_event_queue(event)) { 01473 ast_event_destroy(event); 01474 } 01475 return 0; 01476 }
void ast_event_report_subs | ( | const struct ast_event_sub * | event_sub | ) |
Report current subscriptions to a subscription subscriber.
This reports all of the current subscribers to a subscriber of subscribers to a specific event type. (Try saying that a few times fast).
The idea here is that it is sometimes very useful for a module to know when someone subscribes to events. However, when they first subscribe, this provides that module the ability to request the event core report to them all of the subscriptions to that event type that already exist.
Definition at line 701 of file event.c.
References ast_event_destroy(), AST_EVENT_IE_EVENTTYPE, AST_EVENT_SUB, ast_event_subs, AST_LIST_TRAVERSE, AST_RWDLLIST_RDLOCK, AST_RWDLLIST_TRAVERSE, AST_RWDLLIST_UNLOCK, ast_event_sub::cb, gen_sub_event(), ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_event_ie_val::payload, ast_event_sub::type, ast_event_ie_val::uint, and ast_event_sub::userdata.
Referenced by handle_cli_status(), and start_poll_thread().
00702 { 00703 struct ast_event *event; 00704 struct ast_event_sub *sub; 00705 enum ast_event_type event_type = -1; 00706 struct ast_event_ie_val *ie_val; 00707 00708 if (event_sub->type != AST_EVENT_SUB) 00709 return; 00710 00711 AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) { 00712 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) { 00713 event_type = ie_val->payload.uint; 00714 break; 00715 } 00716 } 00717 00718 if (event_type == -1) 00719 return; 00720 00721 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]); 00722 AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) { 00723 if (event_sub == sub) { 00724 continue; 00725 } 00726 00727 event = gen_sub_event(sub); 00728 if (!event) { 00729 continue; 00730 } 00731 00732 event_sub->cb(event, event_sub->userdata); 00733 00734 ast_event_destroy(event); 00735 } 00736 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]); 00737 }
int ast_event_str_to_event_type | ( | const char * | str, | |
enum ast_event_type * | event_type | |||
) |
Convert a string into an event type.
str | the string to convert | |
event_type | an output parameter for the event type |
0 | success | |
non-zero | failure |
Definition at line 288 of file event.c.
References ARRAY_LEN, ast_strlen_zero(), and event_names.
Referenced by event_dump_cache().
00289 { 00290 int i; 00291 00292 for (i = 0; i < ARRAY_LEN(event_names); i++) { 00293 if (ast_strlen_zero(event_names[i]) || strcasecmp(event_names[i], str)) { 00294 continue; 00295 } 00296 00297 *event_type = i; 00298 return 0; 00299 } 00300 00301 return -1; 00302 }
int ast_event_str_to_ie_type | ( | const char * | str, | |
enum ast_event_ie_type * | ie_type | |||
) |
int ast_event_sub_activate | ( | struct ast_event_sub * | sub | ) |
Activate a dynamically built subscription.
sub | the subscription to activate that was allocated using ast_event_subscribe_new() |
Once a dynamically built subscription has had all of the parameters added to it, it should be activated using this function.
0 | success | |
non-zero | failure |
Definition at line 889 of file event.c.
References ast_event_check_subscriber(), ast_event_destroy(), AST_EVENT_IE_END, AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, ast_event_queue(), AST_EVENT_SUB, AST_EVENT_SUB_NONE, ast_event_subs, AST_RWDLLIST_INSERT_TAIL, AST_RWDLLIST_UNLOCK, AST_RWDLLIST_WRLOCK, gen_sub_event(), and ast_event_sub::type.
Referenced by ast_event_subscribe().
00890 { 00891 if (ast_event_check_subscriber(AST_EVENT_SUB, 00892 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type, 00893 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) { 00894 struct ast_event *event; 00895 00896 event = gen_sub_event(sub); 00897 if (event && ast_event_queue(event)) { 00898 ast_event_destroy(event); 00899 } 00900 } 00901 00902 AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]); 00903 AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry); 00904 AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]); 00905 00906 return 0; 00907 }
int ast_event_sub_append_ie_bitflags | ( | struct ast_event_sub * | sub, | |
enum ast_event_ie_type | ie_type, | |||
uint32_t | flags | |||
) |
Append a bitflags parameter to a subscription.
sub | the dynamic subscription allocated with ast_event_subscribe_new() | |
ie_type | the information element type for the parameter | |
flags | the flags that must be present in the event to match this subscription |
0 | success | |
non-zero | failure |
Definition at line 783 of file event.c.
References ast_calloc, AST_EVENT_IE_PLTYPE_BITFLAGS, AST_EVENT_IE_TOTAL, AST_LIST_INSERT_TAIL, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_event_ie_val::payload, and ast_event_ie_val::uint.
Referenced by ast_event_subscribe().
00785 { 00786 struct ast_event_ie_val *ie_val; 00787 00788 if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) { 00789 return -1; 00790 } 00791 00792 if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) { 00793 return -1; 00794 } 00795 00796 ie_val->ie_type = ie_type; 00797 ie_val->payload.uint = flags; 00798 ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS; 00799 00800 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry); 00801 00802 return 0; 00803 }
int ast_event_sub_append_ie_exists | ( | struct ast_event_sub * | sub, | |
enum ast_event_ie_type | ie_type | |||
) |
Append an 'exists' parameter to a subscription.
sub | the dynamic subscription allocated with ast_event_subscribe_new() | |
ie_type | the information element type that must be present in the event for it to match this subscription. |
0 | success | |
non-zero | failure |
Definition at line 805 of file event.c.
References ast_calloc, AST_EVENT_IE_PLTYPE_EXISTS, AST_EVENT_IE_TOTAL, AST_LIST_INSERT_TAIL, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, and ast_event_sub::ie_vals.
Referenced by ast_event_subscribe().
00807 { 00808 struct ast_event_ie_val *ie_val; 00809 00810 if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) { 00811 return -1; 00812 } 00813 00814 if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) { 00815 return -1; 00816 } 00817 00818 ie_val->ie_type = ie_type; 00819 ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS; 00820 00821 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry); 00822 00823 return 0; 00824 }
int ast_event_sub_append_ie_raw | ( | struct ast_event_sub * | sub, | |
enum ast_event_ie_type | ie_type, | |||
void * | data, | |||
size_t | raw_datalen | |||
) |
Append a raw parameter to a subscription.
sub | the dynamic subscription allocated with ast_event_subscribe_new() | |
ie_type | the information element type for the parameter | |
data | the data that must be present in the event to match this subscription | |
raw_datalen | length of data |
0 | success | |
non-zero | failure |
Definition at line 860 of file event.c.
References ast_calloc, AST_EVENT_IE_PLTYPE_RAW, AST_EVENT_IE_TOTAL, ast_free, AST_LIST_INSERT_TAIL, ast_malloc, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_event_ie_val::payload, ast_event_ie_val::raw, and ast_event_ie_val::raw_datalen.
Referenced by ast_event_subscribe().
00862 { 00863 struct ast_event_ie_val *ie_val; 00864 00865 if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) { 00866 return -1; 00867 } 00868 00869 if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) { 00870 return -1; 00871 } 00872 00873 ie_val->ie_type = ie_type; 00874 ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW; 00875 ie_val->raw_datalen = raw_datalen; 00876 00877 if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) { 00878 ast_free(ie_val); 00879 return -1; 00880 } 00881 00882 memcpy(ie_val->payload.raw, data, raw_datalen); 00883 00884 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry); 00885 00886 return 0; 00887 }
int ast_event_sub_append_ie_str | ( | struct ast_event_sub * | sub, | |
enum ast_event_ie_type | ie_type, | |||
const char * | str | |||
) |
Append a string parameter to a subscription.
sub | the dynamic subscription allocated with ast_event_subscribe_new() | |
ie_type | the information element type for the parameter | |
str | the string that must be present in the event to match this subscription |
0 | success | |
non-zero | failure |
Definition at line 826 of file event.c.
References ast_calloc, AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_TOTAL, ast_free, AST_LIST_INSERT_TAIL, ast_str_hash(), ast_strdup, ast_strdupa, ast_tech_to_upper(), ast_event_ie_val::hash, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_event_ie_val::payload, and ast_event_ie_val::str.
Referenced by ast_event_subscribe(), and handle_devstate_change().
00828 { 00829 struct ast_event_ie_val *ie_val; 00830 00831 if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) { 00832 return -1; 00833 } 00834 00835 if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) { 00836 return -1; 00837 } 00838 00839 ie_val->ie_type = ie_type; 00840 ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR; 00841 00842 if (!(ie_val->payload.str = ast_strdup(str))) { 00843 ast_free(ie_val); 00844 return -1; 00845 } 00846 00847 if (ie_type == AST_EVENT_IE_DEVICE) { 00848 char *uppertech = ast_strdupa(str); 00849 ast_tech_to_upper(uppertech); 00850 ie_val->payload.hash = ast_str_hash(uppertech); 00851 } else { 00852 ie_val->payload.hash = ast_str_hash(str); 00853 } 00854 00855 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry); 00856 00857 return 0; 00858 }
int ast_event_sub_append_ie_uint | ( | struct ast_event_sub * | sub, | |
enum ast_event_ie_type | ie_type, | |||
uint32_t | uint | |||
) |
Append a uint parameter to a subscription.
sub | the dynamic subscription allocated with ast_event_subscribe_new() | |
ie_type | the information element type for the parameter | |
uint | the value that must be present in the event to match this subscription |
0 | success | |
non-zero | failure |
Definition at line 761 of file event.c.
References ast_calloc, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_TOTAL, AST_LIST_INSERT_TAIL, ast_event_ie_val::ie_pltype, ast_event_ie_val::ie_type, ast_event_sub::ie_vals, ast_event_ie_val::payload, and ast_event_ie_val::uint.
Referenced by ast_event_subscribe(), and handle_cli_status().
00763 { 00764 struct ast_event_ie_val *ie_val; 00765 00766 if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) { 00767 return -1; 00768 } 00769 00770 if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) { 00771 return -1; 00772 } 00773 00774 ie_val->ie_type = ie_type; 00775 ie_val->payload.uint = unsigned_int; 00776 ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT; 00777 00778 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry); 00779 00780 return 0; 00781 }
void ast_event_sub_destroy | ( | struct ast_event_sub * | sub | ) |
Destroy an allocated subscription.
sub | the subscription to destroy |
This function should be used when a subscription is allocated with ast_event_subscribe_new(), but for some reason, you want to destroy it instead of activating it. This could be because of an error when reading in the configuration for the dynamically built subscription.
Definition at line 971 of file event.c.
References ast_event_ie_val_destroy(), ast_free, AST_LIST_REMOVE_HEAD, and ast_event_sub::ie_vals.
Referenced by ast_event_unsubscribe(), event_shutdown(), handle_cli_status(), and handle_devstate_change().
00972 { 00973 struct ast_event_ie_val *ie_val; 00974 00975 while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) { 00976 ast_event_ie_val_destroy(ie_val); 00977 } 00978 00979 ast_free(sub); 00980 }
struct ast_event_sub* ast_event_subscribe | ( | enum ast_event_type | event_type, | |
ast_event_cb_t | cb, | |||
const char * | description, | |||
void * | userdata, | |||
... | ||||
) | [read] |
Subscribe to events.
event_type | The type of events to subscribe to | |
cb | The function to be called with events | |
description | Description of the subscription. | |
userdata | data to be passed to the event callback |
The rest of the arguments to this function specify additional parameters for the subscription to filter which events are passed to this subscriber. The arguments must be in sets of:
<enum ast_event_ie_type>, [enum ast_event_ie_pltype, [payload] ]
and must end with AST_EVENT_IE_END.
If the ie_type specified is *not* AST_EVENT_IE_END, then it must be followed by a valid IE payload type. If the payload type specified is AST_EVENT_IE_PLTYPE_EXISTS, then the 3rd argument should not be provided. Otherwise, a payload must also be specified.
Example usage:
peer->mwi_event_sub = ast_event_subscribe(AST_EVENT_MWI, mwi_event_cb, peer, AST_EVENT_IE_MAILBOX, AST_EVENT_IE_PLTYPE_STR, peer->mailbox, AST_EVENT_IE_END);
This creates a subscription to AST_EVENT_MWI events that contain an information element, AST_EVENT_IE_MAILBOX, with the same string value contained in peer->mailbox. Also, the event callback will be passed a pointer to the peer.
Definition at line 909 of file event.c.
References ast_copy_string(), AST_EVENT_IE_END, AST_EVENT_IE_PLTYPE_BITFLAGS, AST_EVENT_IE_PLTYPE_EXISTS, AST_EVENT_IE_PLTYPE_RAW, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_PLTYPE_UNKNOWN, ast_event_sub_activate(), ast_event_sub_append_ie_bitflags(), ast_event_sub_append_ie_exists(), ast_event_sub_append_ie_raw(), ast_event_sub_append_ie_str(), ast_event_sub_append_ie_uint(), ast_event_subscribe_new(), ast_event_sub::description, and str.
Referenced by add_peer_mwi_subs(), add_publish_event(), aji_init_event_distribution(), ast_enable_distributed_devstate(), build_gateway(), build_peer(), cc_generic_agent_start_monitoring(), config_line(), create_new_generic_list(), load_module(), load_pbx(), mkintf(), network_change_event_subscribe(), and start_poll_thread().
00911 { 00912 va_list ap; 00913 enum ast_event_ie_type ie_type; 00914 struct ast_event_sub *sub; 00915 00916 if (!(sub = ast_event_subscribe_new(type, cb, userdata))) { 00917 return NULL; 00918 } 00919 00920 ast_copy_string(sub->description, description, sizeof(sub->description)); 00921 00922 va_start(ap, userdata); 00923 for (ie_type = va_arg(ap, enum ast_event_ie_type); 00924 ie_type != AST_EVENT_IE_END; 00925 ie_type = va_arg(ap, enum ast_event_ie_type)) 00926 { 00927 enum ast_event_ie_pltype ie_pltype; 00928 00929 ie_pltype = va_arg(ap, enum ast_event_ie_pltype); 00930 00931 switch (ie_pltype) { 00932 case AST_EVENT_IE_PLTYPE_UNKNOWN: 00933 break; 00934 case AST_EVENT_IE_PLTYPE_UINT: 00935 { 00936 uint32_t unsigned_int = va_arg(ap, uint32_t); 00937 ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int); 00938 break; 00939 } 00940 case AST_EVENT_IE_PLTYPE_BITFLAGS: 00941 { 00942 uint32_t unsigned_int = va_arg(ap, uint32_t); 00943 ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int); 00944 break; 00945 } 00946 case AST_EVENT_IE_PLTYPE_STR: 00947 { 00948 const char *str = va_arg(ap, const char *); 00949 ast_event_sub_append_ie_str(sub, ie_type, str); 00950 break; 00951 } 00952 case AST_EVENT_IE_PLTYPE_RAW: 00953 { 00954 void *data = va_arg(ap, void *); 00955 size_t data_len = va_arg(ap, size_t); 00956 ast_event_sub_append_ie_raw(sub, ie_type, data, data_len); 00957 break; 00958 } 00959 case AST_EVENT_IE_PLTYPE_EXISTS: 00960 ast_event_sub_append_ie_exists(sub, ie_type); 00961 break; 00962 } 00963 } 00964 va_end(ap); 00965 00966 ast_event_sub_activate(sub); 00967 00968 return sub; 00969 }
struct ast_event_sub* ast_event_subscribe_new | ( | enum ast_event_type | type, | |
ast_event_cb_t | cb, | |||
void * | userdata | |||
) | [read] |
Allocate a subscription, but do not activate it.
type | the event type to subscribe to | |
cb | the function to call when an event matches this subscription | |
userdata | data to pass to the provided callback |
This function should be used when you want to dynamically build a subscription.
Definition at line 739 of file event.c.
References ast_atomic_fetchadd_int(), ast_calloc, ast_log(), ast_event_sub::cb, LOG_ERROR, ast_event_sub::type, ast_event_sub::uniqueid, and ast_event_sub::userdata.
Referenced by ast_event_subscribe(), handle_cli_status(), and handle_devstate_change().
00741 { 00742 struct ast_event_sub *sub; 00743 00744 if (type < 0 || type >= AST_EVENT_TOTAL) { 00745 ast_log(LOG_ERROR, "%u is an invalid type!\n", type); 00746 return NULL; 00747 } 00748 00749 if (!(sub = ast_calloc(1, sizeof(*sub)))) { 00750 return NULL; 00751 } 00752 00753 sub->type = type; 00754 sub->cb = cb; 00755 sub->userdata = userdata; 00756 sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1); 00757 00758 return sub; 00759 }
const char* ast_event_subscriber_get_description | ( | struct ast_event_sub * | sub | ) |
Get description for a subscription.
sub | subscription |
Definition at line 982 of file event.c.
References ast_event_sub::description.
00983 { 00984 return sub ? sub->description : NULL; 00985 }
struct ast_event_sub* ast_event_unsubscribe | ( | struct ast_event_sub * | event_sub | ) | [read] |
Un-subscribe from events.
event_sub | This is the reference to the subscription returned by ast_event_subscribe. |
This function will remove a subscription and free the associated data structures.
Definition at line 987 of file event.c.
References AST_DLLIST_REMOVE, ast_event_check_subscriber(), ast_event_destroy(), AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_END, AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_STR, AST_EVENT_IE_PLTYPE_UINT, AST_EVENT_IE_UNIQUEID, ast_event_new(), ast_event_queue(), ast_event_sub_destroy(), AST_EVENT_SUB_NONE, ast_event_subs, AST_EVENT_UNSUB, AST_RWDLLIST_UNLOCK, AST_RWDLLIST_WRLOCK, ast_event_sub::description, ast_event_sub::type, and ast_event_sub::uniqueid.
Referenced by add_peer_mwi_subs(), cc_generic_agent_destructor(), destroy_dahdi_pvt(), destroy_endpoint(), destroy_mailbox(), generic_agent_devstate_unsubscribe(), generic_monitor_instance_list_destructor(), network_change_event_unsubscribe(), peer_destructor(), publish_event_destroy(), stop_poll_thread(), unload_module(), and unload_pbx().
00988 { 00989 struct ast_event *event; 00990 00991 AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]); 00992 AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry); 00993 AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]); 00994 00995 if (ast_event_check_subscriber(AST_EVENT_UNSUB, 00996 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type, 00997 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) { 00998 00999 event = ast_event_new(AST_EVENT_UNSUB, 01000 AST_EVENT_IE_UNIQUEID, AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid, 01001 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type, 01002 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description, 01003 AST_EVENT_IE_END); 01004 if (event && ast_event_queue(event)) { 01005 ast_event_destroy(event); 01006 } 01007 } 01008 01009 ast_event_sub_destroy(sub); 01010 01011 return NULL; 01012 }