High Performance OPC UA Server SDK  1.2.0.193
ua_deletesubscriptionsrequest Struct Reference

Asynchronous call to delete one or more Subscriptions that belong to the Client’s Session. More...

#include <deletesubscriptionsrequest.h>

Data Fields

uint32_t * subscription_ids
 The Server-assigned identifier for the Subscription.
 
int32_t num_subscription_ids
 Number of elements in ua_deletesubscriptionsrequest::subscription_ids.
 

Related Functions

void ua_deletesubscriptionsrequest_init (struct ua_deletesubscriptionsrequest *t)
 Initialize an ua_deletesubscriptionsrequest struct with a valid value. More...
 
void ua_deletesubscriptionsrequest_clear (struct ua_deletesubscriptionsrequest *t)
 Clear all resources alloctated in an ua_deletesubscriptionsrequest struct. More...
 
int ua_deletesubscriptionsrequest_compare (const struct ua_deletesubscriptionsrequest *a, const struct ua_deletesubscriptionsrequest *b)
 Compare two ua_deletesubscriptionsrequest structs. More...
 
int ua_deletesubscriptionsrequest_copy (struct ua_deletesubscriptionsrequest *dst, const struct ua_deletesubscriptionsrequest *src)
 Create a copy of a ua_deletesubscriptionsrequest struct. More...
 
static int ua_deletesubscriptionsrequest_resize_subscription_ids_array (struct ua_deletesubscriptionsrequest *val, int32_t new_len)
 Resize the subscription_ids array of a ua_deletesubscriptionsrequest struct. More...
 

Detailed Description

Asynchronous call to delete one or more Subscriptions that belong to the Client’s Session.

Successful completion of this Service causes all MonitoredItems that use the Subscription to be deleted. If this is the last Subscription for the Session, then all Publish requests still queued for that Session are dequeued and shall be returned with Bad_NoSubscription.

Subscriptions that were transferred to another Session must be deleted by the Client that owns the Session.

Friends And Related Function Documentation

void ua_deletesubscriptionsrequest_clear ( struct ua_deletesubscriptionsrequest t)
related

Clear all resources alloctated in an ua_deletesubscriptionsrequest struct.

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

int ua_deletesubscriptionsrequest_compare ( const struct ua_deletesubscriptionsrequest a,
const struct ua_deletesubscriptionsrequest b 
)
related

Compare two ua_deletesubscriptionsrequest structs.

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

int ua_deletesubscriptionsrequest_copy ( struct ua_deletesubscriptionsrequest dst,
const struct ua_deletesubscriptionsrequest src 
)
related

Create a copy of a ua_deletesubscriptionsrequest struct.

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

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

static int ua_deletesubscriptionsrequest_resize_subscription_ids_array ( struct ua_deletesubscriptionsrequest val,
int32_t  new_len 
)
related

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

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