Wed Oct 28 11:54:09 2009

Asterisk developer's documentation

eventqent Struct Reference
[AMI functions]

Collaboration diagram for eventqent:

Collaboration graph

Data Fields

int category
struct {
   struct eventqent *   next
char eventdata [1]
unsigned int seq
int usecount

Detailed Description

Linked list of events. Global events are appended to the list by append_event(). The usecount is the number of stored pointers to the element, excluding the list pointers. So an element that is only in the list has a usecount of 0, not 1.

Clients have a pointer to the last event processed, and for each of these clients we track the usecount of the elements. If we have a pointer to an entry in the list, it is safe to navigate it forward because elements will not be deleted, but only appended. The worst that can happen is seeing the pointer still NULL.

When the usecount of an element drops to 0, and the element is the first in the list, we can remove it. Removal is done within the main thread, which is woken up for the purpose.

For simplicity of implementation, we make sure the list is never empty.

Definition at line 112 of file manager.c.

Field Documentation

int category

struct { ... } eq_next

char eventdata[1]

really variable size, allocated by append_event()

Definition at line 117 of file manager.c.

Referenced by action_waitevent(), append_event(), handle_showmaneventq(), and process_events().

struct eventqent* next [read]

Definition at line 116 of file manager.c.

Referenced by ast_instring().

unsigned int seq

sequence number

Definition at line 115 of file manager.c.

Referenced by __manager_event(), and append_event().

int usecount

# of clients who still need the event

Definition at line 113 of file manager.c.

Referenced by append_event(), grab_last(), handle_showmaneventq(), purge_events(), ref_event(), and unref_event().

The documentation for this struct was generated from the following file:

Generated on Wed Oct 28 11:54:09 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6