High Performance OPC UA Server SDK  1.2.0.193
ua_querynextrequest Struct Reference

This Service is used to request the next set of QueryFirst or QueryNext response information that is too large to be sent in a single response. More...

#include <querynextrequest.h>

Data Fields

bool release_continuation_point
 A boolean parameter indicating whether continuation points should be released. More...
 
struct ua_bytestring continuation_point
 Server defined opaque value that represents the continuation point. More...
 

Related Functions

void ua_querynextrequest_init (struct ua_querynextrequest *t)
 Initialize an ua_querynextrequest struct with a valid value. More...
 
void ua_querynextrequest_clear (struct ua_querynextrequest *t)
 Clear all resources alloctated in an ua_querynextrequest struct. More...
 
int ua_querynextrequest_compare (const struct ua_querynextrequest *a, const struct ua_querynextrequest *b)
 Compare two ua_querynextrequest structs. More...
 
int ua_querynextrequest_copy (struct ua_querynextrequest *dst, const struct ua_querynextrequest *src)
 Create a copy of a ua_querynextrequest struct. More...
 

Detailed Description

This Service is used to request the next set of QueryFirst or QueryNext response information that is too large to be sent in a single response.

“Too large” in this context means that the Server is not able to return a larger response or that the number of QueryDataSets to return exceeds the maximum number of QueryDataSets to return that was specified by the Client in the original request. The QueryNext shall be submitted on the same session that was used to submit the QueryFirst or QueryNext that is being continued.

Friends And Related Function Documentation

void ua_querynextrequest_clear ( struct ua_querynextrequest t)
related

Clear all resources alloctated in an ua_querynextrequest struct.

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

int ua_querynextrequest_compare ( const struct ua_querynextrequest a,
const struct ua_querynextrequest b 
)
related

Compare two ua_querynextrequest structs.

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

int ua_querynextrequest_copy ( struct ua_querynextrequest dst,
const struct ua_querynextrequest src 
)
related

Create a copy of a ua_querynextrequest struct.

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

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

Field Documentation

continuation_point

Server defined opaque value that represents the continuation point.

The value of the continuation point was returned to the Client in a previous QueryFirst or QueryNext response. This value is used to identify the previously processed QueryFirst or QueryNext request that is being continued, and the point in the result set from which the browse response is to continue.

release_continuation_point

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.
FALSE
passed ContinuationPoints shall be used to get the next set of QueryDataSEts.

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

If the parameter is set to TRUE, all array parameters in the response shall contain empty arrays.


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