High Performance OPC UA Server SDK  1.2.0.193
ua_browsenextrequest Struct Reference

The BrowseNext service is only used to continue a Browse if not all results could be returned by the Browse or a following BrowseNext call. More...

#include <browsenextrequest.h>

Data Fields

bool release_continuation_points
 A boolean parameter indicating whether continuation points should be released. More...
 
struct ua_bytestringcontinuation_points
 A list of Server-defined opaque values that represent continuation points. More...
 
int32_t num_continuation_points
 Number of elements in ua_browsenextrequest::continuation_points.
 

Related Functions

void ua_browsenextrequest_init (struct ua_browsenextrequest *t)
 Initialize an ua_browsenextrequest struct with a valid value. More...
 
void ua_browsenextrequest_clear (struct ua_browsenextrequest *t)
 Clear all resources alloctated in an ua_browsenextrequest struct. More...
 
int ua_browsenextrequest_compare (const struct ua_browsenextrequest *a, const struct ua_browsenextrequest *b)
 Compare two ua_browsenextrequest structs. More...
 
int ua_browsenextrequest_copy (struct ua_browsenextrequest *dst, const struct ua_browsenextrequest *src)
 Create a copy of a ua_browsenextrequest struct. More...
 
static int ua_browsenextrequest_resize_continuation_points_array (struct ua_browsenextrequest *val, int32_t new_len)
 Resize the continuation_points array of a ua_browsenextrequest struct. More...
 

Detailed Description

The BrowseNext service is only used to continue a Browse if not all results could be returned by the Browse or a following BrowseNext call.

The number of Nodes to return can be limited by the client in the Browse request or by the Server during processing the Browse Service call.

The BrowseNext shall be submitted on the same session that was used to submit the Browse or BrowseNext that is being continued.

Friends And Related Function Documentation

void ua_browsenextrequest_clear ( struct ua_browsenextrequest t)
related

Clear all resources alloctated in an ua_browsenextrequest struct.

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

int ua_browsenextrequest_compare ( const struct ua_browsenextrequest a,
const struct ua_browsenextrequest b 
)
related

Compare two ua_browsenextrequest structs.

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

int ua_browsenextrequest_copy ( struct ua_browsenextrequest dst,
const struct ua_browsenextrequest src 
)
related

Create a copy of a ua_browsenextrequest struct.

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

Initialize an ua_browsenextrequest 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_browsenextrequest struct can also be passed to ua_browsenextrequest_clear. This function will always succeed as long as an ua_browsenextrequest struct is passed to it.

static int ua_browsenextrequest_resize_continuation_points_array ( struct ua_browsenextrequest val,
int32_t  new_len 
)
related

Resize the continuation_points array of a ua_browsenextrequest 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 continuation_points array in number of members.
Returns
Zero on success or ua_statuscode on failure.

Field Documentation

continuation_points

A list of Server-defined opaque values that represent continuation points.

The value for a continuation point was returned to the Client in a previous Browse or BrowseNext response. These values are used to identify the previously processed Browse or BrowseNext request that is being continued and the point in the result set from which the browse response is to continue.

Clients may mix continuation points from different Browse or BrowseNext responses.

release_continuation_points

A boolean parameter indicating whether continuation points should be released.

It has the following values:

TRUE
passed ContinuationPoints shall be reset to free resources in the Server. The continuation points are released and the results and diagnosticInfos arrays are empty.
FALSE
passed ContinuationPoints shall be used to get the next set of browse information.

A Client shall always use the continuation point returned by a Browse or BrowseNext response to free the resources for the continuation point in the Server. If the Client does not want to get the next set of browse information, BrowseNext shall be called with this parameter set to TRUE.


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