High Performance OPC UA Server SDK  1.2.0.193
ua_queryfirstresponse Struct Reference

Data Fields

struct ua_querydatasetquery_data_sets
 The array of QueryDataSets. More...
 
int32_t num_query_data_sets
 Number of elements in ua_queryfirstresponse::query_data_sets.
 
struct ua_bytestring continuation_point
 Server-defined opaque value that identifies the continuation point. More...
 
struct ua_parsingresultparsing_results
 List of parsing results for QueryFirst. More...
 
int32_t num_parsing_results
 Number of elements in ua_queryfirstresponse::parsing_results.
 
struct ua_diagnosticinfodiag_infos
 List of diagnostic information for the requested NodeTypeDescription. More...
 
int32_t num_diag_infos
 Number of elements in ua_queryfirstresponse::diag_infos.
 
struct ua_contentfilterresult filter_result
 A structure that contains any errors associated with the filter. More...
 

Related Functions

void ua_queryfirstresponse_init (struct ua_queryfirstresponse *t)
 Initialize an ua_queryfirstresponse struct with a valid value. More...
 
void ua_queryfirstresponse_clear (struct ua_queryfirstresponse *t)
 Clear all resources alloctated in an ua_queryfirstresponse struct. More...
 
int ua_queryfirstresponse_compare (const struct ua_queryfirstresponse *a, const struct ua_queryfirstresponse *b)
 Compare two ua_queryfirstresponse structs. More...
 
int ua_queryfirstresponse_copy (struct ua_queryfirstresponse *dst, const struct ua_queryfirstresponse *src)
 Create a copy of a ua_queryfirstresponse struct. More...
 
static int ua_queryfirstresponse_resize_query_data_sets_array (struct ua_queryfirstresponse *val, int32_t new_len)
 Resize the query_data_sets array of a ua_queryfirstresponse struct. More...
 
static int ua_queryfirstresponse_resize_parsing_results_array (struct ua_queryfirstresponse *val, int32_t new_len)
 Resize the parsing_results array of a ua_queryfirstresponse struct. More...
 
static int ua_queryfirstresponse_resize_diag_infos_array (struct ua_queryfirstresponse *val, int32_t new_len)
 Resize the diag_infos array of a ua_queryfirstresponse struct. More...
 

Friends And Related Function Documentation

void ua_queryfirstresponse_clear ( struct ua_queryfirstresponse t)
related

Clear all resources alloctated in an ua_queryfirstresponse struct.

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

int ua_queryfirstresponse_compare ( const struct ua_queryfirstresponse a,
const struct ua_queryfirstresponse b 
)
related

Compare two ua_queryfirstresponse structs.

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

int ua_queryfirstresponse_copy ( struct ua_queryfirstresponse dst,
const struct ua_queryfirstresponse src 
)
related

Create a copy of a ua_queryfirstresponse struct.

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

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

static int ua_queryfirstresponse_resize_diag_infos_array ( struct ua_queryfirstresponse val,
int32_t  new_len 
)
related

Resize the diag_infos array of a ua_queryfirstresponse 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 diag_infos array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_queryfirstresponse_resize_parsing_results_array ( struct ua_queryfirstresponse val,
int32_t  new_len 
)
related

Resize the parsing_results array of a ua_queryfirstresponse 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 parsing_results array in number of members.
Returns
Zero on success or ua_statuscode on failure.
static int ua_queryfirstresponse_resize_query_data_sets_array ( struct ua_queryfirstresponse val,
int32_t  new_len 
)
related

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

Field Documentation

continuation_point

Server-defined opaque value that identifies the continuation point.

The continuation point is used only when the Query results are too large to be returned 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 request.

The continuation point is used in the QueryNext Service. If not used, the value of this parameter is null. If a continuation point is returned, the Client shall call QueryNext to get the next set of QueryDataSets or to free the resources for the continuation point in the Server.

A continuation point shall remain active until the Client passes the continuation point to QueryNext or the session is closed. If the maximum continuation points have been reached, the oldest continuation point shall be reset.

diag_infos

List of diagnostic information for the requested NodeTypeDescription.

This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the query request.

filter_result

A structure that contains any errors associated with the filter.

This structure shall be empty if no errors occurred.

parsing_results

List of parsing results for QueryFirst.

The size and order of the list matches the size and order of the NodeTypes request parameter.

This list is populated with any status codes that are related to the processing of the node types that are part of the query. The array can be empty if no errors were encountered. If any node type encountered an error, all node types shall have an associated status code.

query_data_sets

The array of QueryDataSets.

This array is empty if no nodes or references met the ua_QueryFirstRequest::node_types criteria. In this case, the ContinuationPoint parameter shall be empty.


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