Asynchronous call to modify monitored items. More...

#include <modifymonitoreditemsrequest.h>

Data Fields
uint32_t	subscription_id
	The Server-assigned identifier for the Subscription used to qualify the monitoredItemId.

enum ua_timestampstoreturn	ts
	An enumeration that specifies the timestamp Attributes to be transmitted for each MonitoredItem to be modified. More...

struct ua_monitoreditemmodifyrequest *	items_to_modify
	The list of MonitoredItems to modify.

int32_t	num_items_to_modify
	Number of elements in ua_modifymonitoreditemsrequest::items_to_modify.

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

void	ua_modifymonitoreditemsrequest_clear (struct ua_modifymonitoreditemsrequest *t)
	Clear all resources alloctated in an ua_modifymonitoreditemsrequest struct. More...

int	ua_modifymonitoreditemsrequest_compare (const struct ua_modifymonitoreditemsrequest a, const struct ua_modifymonitoreditemsrequest b)
	Compare two ua_modifymonitoreditemsrequest structs. More...

int	ua_modifymonitoreditemsrequest_copy (struct ua_modifymonitoreditemsrequest dst, const struct ua_modifymonitoreditemsrequest src)
	Create a copy of a ua_modifymonitoreditemsrequest struct. More...

static int	ua_modifymonitoreditemsrequest_resize_items_to_modify_array (struct ua_modifymonitoreditemsrequest *val, int32_t new_len)
	Resize the items_to_modify array of a ua_modifymonitoreditemsrequest struct. More...

Detailed Description

Asynchronous call to modify monitored items.

This service is used to modify MonitoredItems of a Subscription. Changes to the MonitoredItem settings shall be applied immediately by the Server. They take effect as soon as practical, but not later than twice the new revisedSamplingInterval.

The return diagnostic info setting in the request header of the CreateMonitoredItems or the last ModifyMonitoredItems Service is applied to the Monitored Items and is used as the diagnostic information settings when sending notifications in the Publish response.

Illegal request values for parameters that can be revised do not generate errors. Instead the server will choose default values and indicate them in the corresponding revised parameter.

Friends And Related Function Documentation

void ua_modifymonitoreditemsrequest_clear ( struct ua_modifymonitoreditemsrequest * t )

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

int ua_modifymonitoreditemsrequest_compare	(	const struct ua_modifymonitoreditemsrequest *	a,
		const struct ua_modifymonitoreditemsrequest *	b
	)

Compares the content of the ua_modifymonitoreditemsrequest struct a to the content of the ua_modifymonitoreditemsrequest 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_modifymonitoreditemsrequest structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_modifymonitoreditemsrequest_copy	(	struct ua_modifymonitoreditemsrequest *	dst,
		const struct ua_modifymonitoreditemsrequest *	src
	)

Copy all fields from struct ua_modifymonitoreditemsrequest 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_modifymonitoreditemsrequest_init ( struct ua_modifymonitoreditemsrequest * t )

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

static int ua_modifymonitoreditemsrequest_resize_items_to_modify_array	(	struct ua_modifymonitoreditemsrequest *	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 items_to_modify array in number of members.

Returns: Zero on success or ua_statuscode on failure.

Field Documentation

ts

An enumeration that specifies the timestamp Attributes to be transmitted for each MonitoredItem to be modified.

When monitoring Events, this applies only to Event fields that are of type DataValue.

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

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

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation