Asynchronously changes the triggering for a monitored item. More...

#include <settriggeringrequest.h>

Data Fields
uint32_t	subscription_id
	The Server-assigned identifier for the subscription that contains the triggering item and the items to report.

uint32_t	triggering_item_id
	Server-assigned ID for the MonitoredItem used as the triggering item.

uint32_t *	links_to_add
	The list of Server-assigned IDs of the items to report that are to be added as triggering links. More...

int32_t	num_links_to_add
	Number of elements in ua_settriggeringrequest::links_to_add.

uint32_t *	links_to_remove
	The list of Server-assigned IDs of the items to report for the triggering links to be deleted. More...

int32_t	num_links_to_remove
	Number of elements in ua_settriggeringrequest::links_to_remove.

Related Functions
void	ua_settriggeringrequest_init (struct ua_settriggeringrequest *t)
	Initialize an ua_settriggeringrequest struct with a valid value. More...

void	ua_settriggeringrequest_clear (struct ua_settriggeringrequest *t)
	Clear all resources alloctated in an ua_settriggeringrequest struct. More...

int	ua_settriggeringrequest_compare (const struct ua_settriggeringrequest a, const struct ua_settriggeringrequest b)
	Compare two ua_settriggeringrequest structs. More...

int	ua_settriggeringrequest_copy (struct ua_settriggeringrequest dst, const struct ua_settriggeringrequest src)
	Create a copy of a ua_settriggeringrequest struct. More...

static int	ua_settriggeringrequest_resize_links_to_add_array (struct ua_settriggeringrequest *val, int32_t new_len)
	Resize the links_to_add array of a ua_settriggeringrequest struct. More...

static int	ua_settriggeringrequest_resize_links_to_remove_array (struct ua_settriggeringrequest *val, int32_t new_len)
	Resize the links_to_remove array of a ua_settriggeringrequest struct. More...

Detailed Description

Asynchronously changes the triggering for a monitored item.

This service is used to create and delete triggering links for a triggering item. The triggering item and the items to report shall belong to the same subscription.

Each triggering link links a triggering item to an item to report. Each link is represented by the MonitoredItem id for the item to report. An error code is returned if this id is invalid.

Friends And Related Function Documentation

void ua_settriggeringrequest_clear ( struct ua_settriggeringrequest * t )

Frees allocated memory like arrays and resets numeric values. The ua_settriggeringrequest struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_settriggeringrequest struct, that was validly decoded or initilized by ua_settriggeringrequest_init.

int ua_settriggeringrequest_compare	(	const struct ua_settriggeringrequest *	a,
		const struct ua_settriggeringrequest *	b
	)

Compares the content of the ua_settriggeringrequest struct a to the content of the ua_settriggeringrequest struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_settriggeringrequest structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_settriggeringrequest_copy	(	struct ua_settriggeringrequest *	dst,
		const struct ua_settriggeringrequest *	src
	)

Copy all fields from struct ua_settriggeringrequest src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_settriggeringrequest_init ( struct ua_settriggeringrequest * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_settriggeringrequest struct can also be passed to ua_settriggeringrequest_clear. This function will always succeed as long as an ua_settriggeringrequest struct is passed to it.

static int ua_settriggeringrequest_resize_links_to_add_array	(	struct ua_settriggeringrequest *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the links_to_add array in number of members.

Returns: Zero on success or ua_statuscode on failure.

static int ua_settriggeringrequest_resize_links_to_remove_array	(	struct ua_settriggeringrequest *	val,
		int32_t	new_len
	)

Depending on new_len and the current size of the array, the array will be created, increased, decreased or deleted. In case array members are removed these are cleared properly, new array members are initialized with zero.

Parameters

new_len New length of the links_to_remove array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

links_to_add

The list of Server-assigned IDs of the items to report that are to be added as triggering links.

The list of linksToRemove is processed before the linksToAdd.

links_to_remove

The list of Server-assigned IDs of the items to report for the triggering links to be deleted.

The list of linksToRemove is processed before the linksToAdd.

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

C:/work/embeddedstack/src/uabase/service/settriggeringrequest.h
C:/work/embeddedstack/src/uabase/service/settriggeringrequest.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation