eventfield

Handle eventfields of events. More...

Data Structures
struct	uaserver_eventfield

Functions
int	uaserver_eventfield_init (void)
	Initialize the eventfield handling. More...
void	uaserver_eventfield_clear (void)
	Clear resources allocated by the eventfield handling. More...
int	uaserver_eventfield_lookup (const struct ua_qualifiedname *browsepath, int32_t browsepath_len)
	Lookup the handle to identify an eventfield. More...
int	uaserver_eventfield_register (const struct uaserver_event_browsepath *path)
	Register an eventfield with its browsepath. More...
int	uaserver_eventfield_register_all (uint16_t nsidx)
	Register all eventfields from the namespace with index nsidx. More...
int	uaserver_eventfield_unregister (const struct uaserver_event_browsepath *path)
	Unregister an eventfield with its browsepath. More...
int	uaserver_eventfield_unregister_all (uint16_t nsidx)
	Unregister all eventfields from the namespace with index nsidx. More...
static int	uaserver_eventfield_lookup_qn (const char *name, uint16_t nsidx)
	Same as uaserver_eventfield_lookup but uses a browsepath of length one, which is a single qualified name.

Variables
int	uaserver_eventfield_base_event_id
	Handle for the BaseEventType field EventId. More...
int	uaserver_eventfield_base_event_type
	Handle for the BaseEventType field EventType. More...
int	uaserver_eventfield_base_local_time
	Handle for the BaseEventType field LocalTime. More...
int	uaserver_eventfield_base_message
	Handle for the BaseEventType field Message. More...
int	uaserver_eventfield_base_receive_time
	Handle for the BaseEventType field ReceiveTime. More...
int	uaserver_eventfield_base_severity
	Handle for the BaseEventType field Severity. More...
int	uaserver_eventfield_base_source_name
	Handle for the BaseEventType field SourceName. More...
int	uaserver_eventfield_base_source_node
	Handle for the BaseEventType field SourceNode. More...
int	uaserver_eventfield_base_time
	Handle for the BaseEventType field Time. More...

Detailed Description

Handle eventfields of events.

Function Documentation

void uaserver_eventfield_clear

(

void

)

Clear resources allocated by the eventfield handling.

This is done automatically by the SDK at server shutdown.

int uaserver_eventfield_init

(

void

)

Initialize the eventfield handling.

This is done automatically by the SDK at server initializiation.

Returns

Zero on success or errorcode on failure.

int uaserver_eventfield_lookup	(	const struct ua_qualifiedname *	browsepath,
		int32_t	browsepath_len
	)

Lookup the handle to identify an eventfield.

The fields of an event are identified by the browsepath from the EventType to the respective field. The EventType is not part of the browsepath, so the browsepath for the 'EventId' field from 'BaseEventType' would be of length one with nsidx=0 and text='EventId'.

For performance and memory improvements the SDK internally works with unique handles instead of browsepaths for identifing eventfields.

Returns

Non-negative handle on success or negative errorcode on failure.

int uaserver_eventfield_register

(

const struct uaserver_event_browsepath *

path

)

Register an eventfield with its browsepath.

After registering, the eventfield is availabe as handle, see uaserver_eventfield_lookup.

At shutdown the browsepath must be unregistered with uaserver_eventfield_unregister. The browsepath is refcounted, so when the same browsepath is registered mulitple times it must be unregistered the same number of times.

Returns

Non-negative handle on success or negative errorcode on failure.

int uaserver_eventfield_register_all

(

uint16_t

nsidx

)

Register all eventfields from the namespace with index nsidx.

Traverse the addressspace and register all eventfields from EventTypes with the given nsidx. In case of error already registered eventfields are not unregistered.

Returns

Zero on success or negative errorcode on failure.

int uaserver_eventfield_unregister

(

const struct uaserver_event_browsepath *

path

)

Unregister an eventfield with its browsepath.

See also

uaserver_eventfield_register

Returns

Zero on success or negative errorcode on failure.

int uaserver_eventfield_unregister_all

(

uint16_t

nsidx

)

Unregister all eventfields from the namespace with index nsidx.

See also

uaserver_eventfield_register_all

Returns

Zero on success or negative errorcode on failure.

Variable Documentation

int uaserver_eventfield_base_event_id

Handle for the BaseEventType field EventId.

int uaserver_eventfield_base_event_type

Handle for the BaseEventType field EventType.

int uaserver_eventfield_base_local_time

Handle for the BaseEventType field LocalTime.

int uaserver_eventfield_base_message

Handle for the BaseEventType field Message.

int uaserver_eventfield_base_receive_time

Handle for the BaseEventType field ReceiveTime.

int uaserver_eventfield_base_severity

Handle for the BaseEventType field Severity.

int uaserver_eventfield_base_source_name

Handle for the BaseEventType field SourceName.

int uaserver_eventfield_base_source_node

Handle for the BaseEventType field SourceNode.

int uaserver_eventfield_base_time

Handle for the BaseEventType field Time.