UaEndpoint Class Reference

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>

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)
void	setEndpointUrl (UaString sEndpointUrl, OpcUa_Boolean useAlsoAsStackUrl)
void	setStackEndpointUrl (UaString sStackEndpointUrl)
UaStatus	addSecuritySetting (const UaEndpointSecuritySetting &endpointSecuritySetting)
void	setPkiConfiguration (const UaByteString &serverCertificate, const UaByteString &serverPrivateKey, UaPkiProviderOpenSSL *pPkiProviderOpenSSL)
OpcUa_Handle	hPKIConfig () 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

UaEndpoint & UaEndpoint::operator=

(

const UaEndpoint &

other

)

Implements the operator = for UaEndpoint.

Parameters:

other

the UaEndpoint to assign.

Returns:

Assignment operator.

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::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::setStackEndpointUrl

(

UaString

sStackEndpointUrl

)

Set the URL for the Endpoint used for the stack.

Parameters:

sStackEndpointUrl

the URL for the Endpoint used for the stack.

UaStatus UaEndpoint::addSecuritySetting

(

const UaEndpointSecuritySetting &

endpointSecuritySetting

)

Add a security setting to the endpoint.

Parameters:

endpointSecuritySetting

security setting from the endpoint.

Returns:

Error code

void UaEndpoint::setPkiConfiguration	(	const UaByteString &	serverCertificate,
		const UaByteString &	serverPrivateKey,
		UaPkiProviderOpenSSL *	pPkiProviderOpenSSL
	)

Set PKI configuration and Endpoint certificate.

Parameters:

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

OpcUa_Handle UaEndpoint::hPKIConfig

(

)

const

Get the handle to the PKI configuration.

Returns:

a handle to the Endpoint

---

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

• src/uaserver/uaservercpp/uamodule/uaendpoint.h
• src/uaserver/uaservercpp/uamodule/uaendpoint.cpp