ax_event.h File Reference

The AXEvent and its associated functions. More...

Go to the source code of this file.

Typedefs
typedef struct _AXEvent	AXEvent
	The AXEvent is an opaque data type required to send and receive events.

Functions
	__attribute__ ((deprecated)) AXEvent *ax_event_new(AXEventKeyValueSet *key_value_set
	Creates a new AXEvent. More...
AXEvent *	ax_event_new2 (AXEventKeyValueSet *key_value_set, GDateTime *time_stamp)
	Creates a new AXEvent. More...
void	ax_event_free (AXEvent *event)
	Free an AXEvent. More...
const AXEventKeyValueSet *	ax_event_get_key_value_set (AXEvent *event)
	Get the AXEventKeyValueSet associated with the AXEvent. More...
GDateTime *	ax_event_get_time_stamp2 (AXEvent *event)
	Get the time stamp associated with the AXEvent. More...

Variables
GTimeVal *	time_stamp

Detailed Description

The AXEvent and its associated functions.

Events

An event is an instance of an event declaration and may not contain any unset values. Events with unset values are invalid and are undeliverable. The event's type must be declared before the producer can send the event. An undeclared event is undeliverable. Each event contains a key/value set and a settable timestamp. The key/value set describes the keys and values that constitute the event. The timestamp will be interpreted by the consumer as the time at which the event occured.

Events, both stateless events and property states, sent by an event producer are delivered to event consumers as AXEvent's.

Function Documentation

__attribute__()

__attribute__

(

(deprecated)

)

Creates a new AXEvent.

Get the time stamp associated with the AXEvent.

Deprecated:

This function has been deprecated. Use ax_event_new2 instead.

Parameters

key_value_set	An AXEventKeyValueSet.
time_stamp	The time when the event occurred or NULL. If NULL the current time will be set implicitly.

Returns

A new AXEvent.

Deprecated:

This function has been deprecated. Use ax_event_get_time_stamp2 instead.

Parameters

event

An AXEvent.

Returns

The time stamp associated with the AXEvent.

ax_event_new2()

AXEvent* ax_event_new2	(	AXEventKeyValueSet *	key_value_set,
		GDateTime *	time_stamp
	)

Creates a new AXEvent.

Parameters

key_value_set	An AXEventKeyValueSet.
datetime	The time when the event occurred or NULL. If 0 the current time will be set implicitly.

Returns

A new AXEvent.

ax_event_free()

void ax_event_free

(

AXEvent *

event

)

Free an AXEvent.

Parameters

event

An AXEvent.

Examples:

ax_event_subscription_example.c.

ax_event_get_key_value_set()

const AXEventKeyValueSet* ax_event_get_key_value_set

(

AXEvent *

event

)

Get the AXEventKeyValueSet associated with the AXEvent.

Parameters

event

An AXEvent.

Returns

The AXEventKeyValueSet associated with the AXEvent.

Examples:

ax_event_subscription_example.c.

ax_event_get_time_stamp2()

GDateTime* ax_event_get_time_stamp2

(

AXEvent *

event

)

Get the time stamp associated with the AXEvent.

Parameters

event

An AXEvent.

Returns

The time stamp associated with the AXEvent.