event_t Struct Reference

The structure which represents an event. More...

#include <event.h>

Collaboration diagram for event_t:

[legend]

Data Fields
int	type
	Type of event.
union {
int   signal
	Signal number for signal-type events.Use EVENT_ANY_SIGNAL to match any signal.
const wchar_t *   variable
	Variable name for variable-type events.
pid_t   pid
	Process id for process-type events.
int   job_id
	Job id for EVENT_JOB_ID type events.
const wchar_t *   param
	The parameter describing this generic event.
}	param1
	The type-specific parameter.
const wchar_t *	function_name
	The name of the event handler function.
array_list_t	arguments
	The argument list.

---

Detailed Description

The structure which represents an event.

The event_t struct has several event-related use-cases:

• When used as a parameter to event_add, it represents a class of events, and function_name is the name of the function which will be called whenever an event matching the specified class occurs. This is also how events are stored internally.
• When used as a parameter to event_get, event_remove and event_fire, it represents a class of events, and if the function_name field is non-zero, only events which call the specified function will be returned.

---

Field Documentation

pid_t event_t::pid

Process id for process-type events.

Use EVENT_ANY_PID to match any pid.

Referenced by builtin_function(), event_get_desc(), event_match(), and functions_def().

array_list_t event_t::arguments

The argument list.

Only used when sending a new event using event_fire. In all other situations, the value of this variable is ignored.

Referenced by env_remove(), env_set(), event_copy(), event_fire_delayed(), event_fire_internal(), event_free(), proc_destroy(), proc_fire_event(), proc_init(), and universal_callback().

---

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

• event.h