High Performance OPC UA Server SDK  1.2.0.193
ua_eventfilter Struct Reference

Provides for the filtering and content selection of Event Subscriptions. More...

#include <eventfilter.h>

Data Fields

struct ua_simpleattributeoperandselect_clauses
 List of the values to return with each event in a notification. More...
 
int32_t num_select_clauses
 Number of elements in ua_eventfilter::select_clauses.
 
struct ua_contentfilter where_clause
 Limit the Notifications to those events that match the criteria defined by this ua_contentfilter. More...
 

Related Functions

void ua_eventfilter_init (struct ua_eventfilter *t)
 Initialize an ua_eventfilter struct with a valid value. More...
 
void ua_eventfilter_clear (struct ua_eventfilter *t)
 Clear all resources alloctated in an ua_eventfilter struct. More...
 
int ua_eventfilter_compare (const struct ua_eventfilter *a, const struct ua_eventfilter *b)
 Compare two ua_eventfilter structs. More...
 
int ua_eventfilter_copy (struct ua_eventfilter *dst, const struct ua_eventfilter *src)
 Create a copy of a ua_eventfilter struct. More...
 
static int ua_eventfilter_resize_select_clauses_array (struct ua_eventfilter *val, int32_t new_len)
 Resize the select_clauses array of a ua_eventfilter struct. More...
 

Detailed Description

Provides for the filtering and content selection of Event Subscriptions.

Friends And Related Function Documentation

void ua_eventfilter_clear ( struct ua_eventfilter t)
related

Clear all resources alloctated in an ua_eventfilter struct.

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

int ua_eventfilter_compare ( const struct ua_eventfilter a,
const struct ua_eventfilter b 
)
related

Compare two ua_eventfilter structs.

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

int ua_eventfilter_copy ( struct ua_eventfilter dst,
const struct ua_eventfilter src 
)
related

Create a copy of a ua_eventfilter struct.

Copy all fields from struct ua_eventfilter 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_eventfilter_init ( struct ua_eventfilter t)
related

Initialize an ua_eventfilter struct with a valid value.

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

static int ua_eventfilter_resize_select_clauses_array ( struct ua_eventfilter val,
int32_t  new_len 
)
related

Resize the select_clauses array of a ua_eventfilter struct.

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_lenNew length of the select_clauses array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

select_clauses

List of the values to return with each event in a notification.

At least one valid clause shall be specified.

where_clause

Limit the Notifications to those events that match the criteria defined by this ua_contentfilter.

The ua_attributeoperand structure may not be used in an EventFilter.


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