Platform layer handling class. More...

#include <uaplatformlayer.h>

Static Public Member Functions
static int	init ()
	Initialize UA Stack platform layer.
static int	reInitConfig ()
	Change configuration settings for UA Stack platform layer.
static void	cleanup ()
	Clean up UA Stack platform layer.
static void	changeTraceSettings (OpcUa_Boolean bTraceEnabled, OpcUa_UInt32 uTraceLevel)
	Change default trace settings.
static void	changeSerializerSettings (OpcUa_Int32 iMaxAlloc, OpcUa_Int32 iMaxStringLength, OpcUa_Int32 iMaxByteStringLength, OpcUa_Int32 iMaxArrayLength, OpcUa_Int32 iMaxMessageSize)
	Change default serializer settings.
static void	changeThreadPoolSettings (OpcUa_Boolean bEnabled, OpcUa_Int32 iMinThreads, OpcUa_Int32 iMaxThreads, OpcUa_Int32 iMaxJobs, OpcUa_Boolean bBlockOnAdd, OpcUa_UInt32 nTimeout)
	Change default thread pool settings.
static void	changeTransportSettings (OpcUa_Boolean bTcpListener_ClientThreadsEnabled, OpcUa_Int32 iTcpListener_DefaultChunkSize, OpcUa_Int32 iTcpConnection_DefaultChunkSize, OpcUa_Int32 iTcpTransport_MaxMessageLength, OpcUa_Int32 iTcpTransport_MaxChunkCount)
	Change default transport settings.
static OpcUa_UInt32	nMaxMessageSize ()
	Get the current maxMessageSize setting for the serializer.

Detailed Description

Platform layer handling class.

Member Function Documentation

void UaPlatformLayer::changeSerializerSettings	(	OpcUa_Int32	iMaxAlloc,
		OpcUa_Int32	iMaxStringLength,
		OpcUa_Int32	iMaxByteStringLength,
		OpcUa_Int32	iMaxArrayLength,
		OpcUa_Int32	iMaxMessageSize
	)

static

Change default serializer settings.

These are the Security constraints for the serializer. Set this values carefully.

Parameters

iMaxAlloc	The largest size for a memory block the serializer can do when deserializing a message
iMaxStringLength	The largest string accepted by the serializer
iMaxByteStringLength	The largest byte string accepted by the serializer
iMaxArrayLength	Maximum number of elements in an array accepted by the serializer
iMaxMessageSize	The maximum number of bytes per message in total

void UaPlatformLayer::changeThreadPoolSettings	(	OpcUa_Boolean	bEnabled,
		OpcUa_Int32	iMinThreads,
		OpcUa_Int32	iMaxThreads,
		OpcUa_Int32	iMaxJobs,
		OpcUa_Boolean	bBlockOnAdd,
		OpcUa_UInt32	nTimeout
	)

static

Change default thread pool settings.

Be careful! Enabling the thread pool has severe implications on the behavior of your server!

Parameters

bEnabled	Controls whether the secure listener uses a thread pool to dispatch received requests
iMinThreads	The minimum number of threads in the thread pool
iMaxThreads	The maximum number of threads in the thread pool
iMaxJobs	The length of the queue with jobs waiting for a free thread
bBlockOnAdd	If MaxJobs is reached the add operation can block or return an error
nTimeout	If the add operation blocks on a full job queue, this value sets the max waiting time

void UaPlatformLayer::changeTraceSettings	(	OpcUa_Boolean	bTraceEnabled,
		OpcUa_UInt32	uTraceLevel
	)

static

Change default trace settings.

Parameters

bTraceEnabled	Globally enable/disable trace output from the stack (exclude platform layer)
uTraceLevel	Configure the level of messages traced OPCUA_TRACE_OUTPUT_LEVEL_NONE OPCUA_TRACE_OUTPUT_LEVEL_ERROR OPCUA_TRACE_OUTPUT_LEVEL_WARNING OPCUA_TRACE_OUTPUT_LEVEL_SYSTEM OPCUA_TRACE_OUTPUT_LEVEL_INFO OPCUA_TRACE_OUTPUT_LEVEL_DEBUG OPCUA_TRACE_OUTPUT_LEVEL_CONTENT OPCUA_TRACE_OUTPUT_LEVEL_ALL

void UaPlatformLayer::changeTransportSettings	(	OpcUa_Boolean	bTcpListener_ClientThreadsEnabled,
		OpcUa_Int32	iTcpListener_DefaultChunkSize,
		OpcUa_Int32	iTcpConnection_DefaultChunkSize,
		OpcUa_Int32	iTcpTransport_MaxMessageLength,
		OpcUa_Int32	iTcpTransport_MaxChunkCount
	)

static

Change default transport settings.

Parameters

bTcpListener_ClientThreadsEnabled
iTcpListener_DefaultChunkSize
iTcpConnection_DefaultChunkSize
iTcpTransport_MaxMessageLength
iTcpTransport_MaxChunkCount

void UaPlatformLayer::cleanup ( )

static

Clean up UA Stack platform layer.

None of the OpcUa_xxx functions can be used after calling this method.

int UaPlatformLayer::init ( )

static

Initialize UA Stack platform layer.

None of the OpcUa_xxx functions can be used before the platform layer is assigned to the stack with this method.

static OpcUa_UInt32 UaPlatformLayer::nMaxMessageSize ( )

inlinestatic

Get the current maxMessageSize setting for the serializer.

int UaPlatformLayer::reInitConfig ( )

static

Change configuration settings for UA Stack platform layer.

This method should be called to change settings before UA communication is started.

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