Container class for optimized handling of OPC UA Endpoint description data. The list of endpoints is used by the SDK to open the endpoints in the UA Ansi C Stack when the UA Module is started with UaModule::startUp. For each endpoint in the list the method OpcUa_Endpoint_Open is called in the UA Ansi C Stack. The list is also used to return the list of endpoint descriptions in the UA Service implementation for GetEndpoints. In this case the Service returns multiple endpoint description for each endpoint if more than one security policy or more than one security mode is set. More...

#include <uaendpoint.h>

Inheritance diagram for UaEndpoint:

[legend]

Collaboration diagram for UaEndpoint:

[legend]

List of all members.

Public Member Functions
	UaEndpoint ()
	UaEndpoint (const UaEndpoint &other)
virtual	~UaEndpoint ()
UaEndpoint &	operator= (const UaEndpoint &other)
UaStatus	setSerializerType (OpcUa_Endpoint_SerializerType eSerializerType)
OpcUa_Endpoint_SerializerType	eSerializerType () const
void	setEndpointUrl (UaString sEndpointUrl, OpcUa_Boolean useAlsoAsStackUrl)
UaString	sEndpointUrl () const
void	setStackEndpointUrl (UaString sStackEndpointUrl)
UaStatus	addSecuritySetting (const UaEndpointSecuritySetting &endpointSecuritySetting)
const UaEndpointSecuritySettingArray &	securitySettings () const
void	setPkiConfiguration (const UaByteString &serverCertificate, const UaByteString &serverPrivateKey, UaPkiProvider *pPkiProvider)
OpcUa_Handle	hPKIConfig () const
void	setEndpointHandle (OpcUa_Endpoint endpoint)
OpcUa_Endpoint	endpointHandle () const
void	setIsVisible (OpcUa_Boolean isVisible)
OpcUa_Boolean	isVisible () const
void	setIsTransparentRedundant (OpcUa_Boolean isTransparentRedundant)
OpcUa_Boolean	isTransparentRedundant () const

Detailed Description

Container class for optimized handling of OPC UA Endpoint description data. The list of endpoints is used by the SDK to open the endpoints in the UA Ansi C Stack when the UA Module is started with UaModule::startUp. For each endpoint in the list the method OpcUa_Endpoint_Open is called in the UA Ansi C Stack. The list is also used to return the list of endpoint descriptions in the UA Service implementation for GetEndpoints. In this case the Service returns multiple endpoint description for each endpoint if more than one security policy or more than one security mode is set.

UaEndpoint

Constructor & Destructor Documentation

UaEndpoint::UaEndpoint ( )

construction

UaEndpoint::UaEndpoint ( const UaEndpoint & other )

construction

Parameters:

other the UaEndpoint to assign.

UaEndpoint::~UaEndpoint ( ) [virtual]

destruction

Member Function Documentation

UaStatus UaEndpoint::addSecuritySetting ( const UaEndpointSecuritySetting & endpointSecuritySetting )

Add a security setting to the endpoint.

Parameters:

endpointSecuritySetting security setting from the endpoint.

Returns:: Error code

OpcUa_Endpoint UaEndpoint::endpointHandle ( ) const [inline]

Get the URL used for the endpoint.

OpcUa_Endpoint_SerializerType UaEndpoint::eSerializerType ( ) const [inline]

Get the serializer tpye used for the endpoint.

Returns:: Serializer type.

See also:: setSerializerType

OpcUa_Handle UaEndpoint::hPKIConfig ( ) const

Get the handle to the PKI configuration.

Returns:: a handle to the Endpoint

OpcUa_Boolean UaEndpoint::isTransparentRedundant ( ) const

Get the flag that indicates if the endpoint support transparent redundancy.

OpcUa_Boolean UaEndpoint::isVisible ( ) const

Get the flag that indicates if the endpoint is contained in GetEndpoints.

UaEndpoint & UaEndpoint::operator= ( const UaEndpoint & other )

Implements the operator = for UaEndpoint.

Parameters:

other the UaEndpoint to assign.

Returns:: Assignment operator.

const UaEndpointSecuritySettingArray& UaEndpoint::securitySettings ( ) const [inline]

Get the list of security settings.

Returns:: List of security settings.

See also:: addSecuritySetting

UaString UaEndpoint::sEndpointUrl ( ) const [inline]

Get the URL used for the endpoint.

void UaEndpoint::setEndpointHandle ( OpcUa_Endpoint endpoint )

Set the Endpoint handle for the Endpoint opened with the stack.

void UaEndpoint::setEndpointUrl	(	UaString	sEndpointUrl,
		OpcUa_Boolean	useAlsoAsStackUrl
	)

Set the URL used for the endpoint.

Parameters:

sEndpointUrl	the URL used for the endpoint.
useAlsoAsStackUrl	true if also used false if not.

void UaEndpoint::setIsTransparentRedundant ( OpcUa_Boolean isTransparentRedundant )

Set the flag that indicates if the endpoint support transparent redundancy.

void UaEndpoint::setIsVisible ( OpcUa_Boolean isVisible )

Set the flag that indicates if the endpoint is contained in GetEndpoints.

void UaEndpoint::setPkiConfiguration	(	const UaByteString &	serverCertificate,
		const UaByteString &	serverPrivateKey,
		UaPkiProvider *	pPkiProvider
	)

Set PKI configuration and Endpoint certificate.

Parameters:

serverCertificate	Server certificate used for this Endpoint.
serverPrivateKey	Server private key used for this Endpoint.
pPkiProvider	PKI provider OpenSSL.

UaStatus UaEndpoint::setSerializerType ( OpcUa_Endpoint_SerializerType eSerializerType )

Set the serializer tpye used for the endpoint.

Parameters:

eSerializerType Serializer tpye enumeration value. Possible enumeration values are OpcUa_Endpoint_SerializerType_Binary OpcUa_Endpoint_SerializerType_Xml

Returns:: Error code

void UaEndpoint::setStackEndpointUrl ( UaString sStackEndpointUrl )

Set the URL for the Endpoint used for the stack. This URL allows to define a specific address the stack should use to bind to.

Set the URL for the Endpoint used for the stack.

Parameters:

sStackEndpointUrl the URL for the Endpoint used for the stack.

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

/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaendpoint.h
/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uaendpoint.cpp

UaEndpoint Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation