High Performance OPC UA Server SDK  1.2.0.193
ua_createsubscriptionresponse Struct Reference

Data Fields

uint32_t subscription_id
 The Server-assigned identifier for the Subscription. More...
 
double revised_publishing_interval
 The actual publishing interval that the Server will use, expressed in milliseconds. More...
 
uint32_t revised_lifetime_count
 The lifetime of the Subscription shall be a minimum of three times the keep-alive interval negotiated by the Server.
 
uint32_t revised_max_keep_alive_count
 The actual maximum keep-alive count. More...
 

Related Functions

void ua_createsubscriptionresponse_init (struct ua_createsubscriptionresponse *t)
 Initialize an ua_createsubscriptionresponse struct with a valid value. More...
 
void ua_createsubscriptionresponse_clear (struct ua_createsubscriptionresponse *t)
 Clear all resources alloctated in an ua_createsubscriptionresponse struct. More...
 
int ua_createsubscriptionresponse_compare (const struct ua_createsubscriptionresponse *a, const struct ua_createsubscriptionresponse *b)
 Compare two ua_createsubscriptionresponse structs. More...
 
int ua_createsubscriptionresponse_copy (struct ua_createsubscriptionresponse *dst, const struct ua_createsubscriptionresponse *src)
 Create a copy of a ua_createsubscriptionresponse struct. More...
 

Friends And Related Function Documentation

void ua_createsubscriptionresponse_clear ( struct ua_createsubscriptionresponse t)
related

Clear all resources alloctated in an ua_createsubscriptionresponse struct.

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

int ua_createsubscriptionresponse_compare ( const struct ua_createsubscriptionresponse a,
const struct ua_createsubscriptionresponse b 
)
related

Compare two ua_createsubscriptionresponse structs.

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

int ua_createsubscriptionresponse_copy ( struct ua_createsubscriptionresponse dst,
const struct ua_createsubscriptionresponse src 
)
related

Create a copy of a ua_createsubscriptionresponse struct.

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

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

Field Documentation

revised_max_keep_alive_count

The actual maximum keep-alive count.

The Server should attempt to honor the Client request for this parameter, but may negotiate this value up or down to meet its own constraints.

revised_publishing_interval

The actual publishing interval that the Server will use, expressed in milliseconds.

The Server should attempt to honor the Client request for this parameter, but may negotiate this value up or down to meet its own constraints.

subscription_id

The Server-assigned identifier for the Subscription.

This identifier shall be unique for the entire Server, not just for the Session, in order to allow the Subscription to be transferred to another Session using the TransferSubscriptions service.


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