High Performance OPC UA Server SDK  1.2.0.193
ua_subscriptionacknowledgement Struct Reference

A structure that is defined as the type of the subscriptionAcknowledgements parameter of the Publish service. More...

#include <subscriptionacknowledgement.h>

Data Fields

uint32_t subscription_id
 The Server assigned identifier for a Subscription.
 
uint32_t sequence_number
 The sequence number being acknowledged. More...
 

Related Functions

void ua_subscriptionacknowledgement_init (struct ua_subscriptionacknowledgement *t)
 Initialize an ua_subscriptionacknowledgement struct with a valid value. More...
 
void ua_subscriptionacknowledgement_clear (struct ua_subscriptionacknowledgement *t)
 Clear all resources alloctated in an ua_subscriptionacknowledgement struct. More...
 
int ua_subscriptionacknowledgement_compare (const struct ua_subscriptionacknowledgement *a, const struct ua_subscriptionacknowledgement *b)
 Compare two ua_subscriptionacknowledgement structs. More...
 
int ua_subscriptionacknowledgement_copy (struct ua_subscriptionacknowledgement *dst, const struct ua_subscriptionacknowledgement *src)
 Create a copy of a ua_subscriptionacknowledgement struct. More...
 

Detailed Description

A structure that is defined as the type of the subscriptionAcknowledgements parameter of the Publish service.

Friends And Related Function Documentation

void ua_subscriptionacknowledgement_clear ( struct ua_subscriptionacknowledgement t)
related

Clear all resources alloctated in an ua_subscriptionacknowledgement struct.

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

int ua_subscriptionacknowledgement_compare ( const struct ua_subscriptionacknowledgement a,
const struct ua_subscriptionacknowledgement b 
)
related

Compare two ua_subscriptionacknowledgement structs.

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

int ua_subscriptionacknowledgement_copy ( struct ua_subscriptionacknowledgement dst,
const struct ua_subscriptionacknowledgement src 
)
related

Create a copy of a ua_subscriptionacknowledgement struct.

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

Initialize an ua_subscriptionacknowledgement 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_subscriptionacknowledgement struct can also be passed to ua_subscriptionacknowledgement_compare, ua_subscriptionacknowledgement_copy and ua_subscriptionacknowledgement_clear. This function will always succeed as long as an ua_subscriptionacknowledgement struct is passed to it.

Field Documentation

sequence_number

The sequence number being acknowledged.

The Server may delete the message with this sequence number from its retransmission queue.


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