Asynchronously cancels outstanding service requests on the OPC UA server. More...

#include <cancelrequest.h>

Data Fields
uint32_t	request_handle
	The request handle assigned to one or more requests that should be cancelled. More...

Related Functions
void	ua_cancelrequest_init (struct ua_cancelrequest *t)
	Initialize an ua_cancelrequest struct with a valid value. More...

void	ua_cancelrequest_clear (struct ua_cancelrequest *t)
	Clear all resources alloctated in an ua_cancelrequest struct. More...

int	ua_cancelrequest_compare (const struct ua_cancelrequest a, const struct ua_cancelrequest b)
	Compare two ua_cancelrequest structs. More...

int	ua_cancelrequest_copy (struct ua_cancelrequest dst, const struct ua_cancelrequest src)
	Create a copy of a ua_cancelrequest struct. More...

Detailed Description

Asynchronously cancels outstanding service requests on the OPC UA server.

Friends And Related Function Documentation

void ua_cancelrequest_clear ( struct ua_cancelrequest * t )

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

int ua_cancelrequest_compare	(	const struct ua_cancelrequest *	a,
		const struct ua_cancelrequest *	b
	)

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

int ua_cancelrequest_copy	(	struct ua_cancelrequest *	dst,
		const struct ua_cancelrequest *	src
	)

Copy all fields from struct ua_cancelrequest 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_cancelrequest_init ( struct ua_cancelrequest * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_cancelrequest struct can also be passed to ua_cancelrequest_clear. This function will always succeed as long as an ua_cancelrequest struct is passed to it.

Field Documentation

request_handle

The request handle assigned to one or more requests that should be cancelled.

All outstanding requests with the matching requestHandle shall be cancelled.

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

C:/work/embeddedstack/src/uabase/service/cancelrequest.h
C:/work/embeddedstack/src/uabase/service/cancelrequest.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation