UA Server SDK C++ Bundle  1.3.3.206
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
UaEndpoint Class Reference

UaEndpoint. More...

#include <uaendpoint.h>

Inherited by UaEndpointSettings, and UaEndpointXml.

Public Member Functions

 UaEndpoint ()
 construction
 
 UaEndpoint (const UaEndpoint &other)
 construction More...
 
virtual ~UaEndpoint ()
 destruction
 
UaEndpointoperator= (const UaEndpoint &other)
 Implements the operator = for UaEndpoint. More...
 
UaStatus setSerializerType (OpcUa_Endpoint_SerializerType eSerializerType)
 Set the serializer type used for the endpoint. More...
 
OpcUa_Endpoint_SerializerType eSerializerType () const
 Get the serializer type used for the endpoint. More...
 
void setEndpointUrl (UaString sEndpointUrl, OpcUa_Boolean useAlsoAsStackUrl)
 Set the URL used for the endpoint. More...
 
UaString sEndpointUrl () const
 Get the URL used for the endpoint. More...
 
void setStackEndpointUrl (UaString sStackEndpointUrl)
 Set the URL for the Endpoint used for the stack. More...
 
UaStatus addSecuritySetting (const UaEndpointSecuritySetting &endpointSecuritySetting)
 Add a security setting to the endpoint. More...
 
const
UaEndpointSecuritySettingArray
securitySettings () const
 Get the list of security settings. More...
 
void setPkiConfiguration (const UaByteString &serverCertificate, const UaByteString &serverPrivateKey, UaPkiProvider *pPkiProvider)
 Set PKI configuration and Endpoint certificate. More...
 
OpcUa_Handle hPKIConfig () const
 Get the handle to the PKI configuration. More...
 
UaPkiProviderpkiProvider () const
 Get the PKI provider. More...
 
void setEndpointHandle (OpcUa_Endpoint endpoint)
 Set the Endpoint handle for the Endpoint opened with the stack. More...
 
OpcUa_Endpoint endpointHandle () const
 Get the URL used for the endpoint. More...
 
void setIsVisible (OpcUa_Boolean isVisible)
 Set the flag that indicates if the endpoint is contained in GetEndpoints. More...
 
OpcUa_Boolean isVisible () const
 Get the flag that indicates if the endpoint is contained in GetEndpoints. More...
 
void setIsDiscoveryUrl (OpcUa_Boolean isDiscoveryUrl)
 Set the flag that indicates if the endpoint URL is provided as discovery URL. More...
 
OpcUa_Boolean isDiscoveryUrl () const
 Get the flag that indicates if the endpoint URL is provided as discovery URL. More...
 
void setIsTransparentRedundant (OpcUa_Boolean isTransparentRedundant)
 Set the flag that indicates if the endpoint support transparent redundancy. More...
 
OpcUa_Boolean isTransparentRedundant () const
 Get the flag that indicates if the endpoint support transparent redundancy. More...
 

Detailed Description

UaEndpoint.

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.

Constructor & Destructor Documentation

UaEndpoint::UaEndpoint ( const UaEndpoint other)

construction

Parameters
otherthe UaEndpoint to assign.

Member Function Documentation

UaStatus UaEndpoint::addSecuritySetting ( const UaEndpointSecuritySetting endpointSecuritySetting)

Add a security setting to the endpoint.

Parameters
endpointSecuritySettingsecurity 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 type 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::isDiscoveryUrl ( ) const

Get the flag that indicates if the endpoint URL is provided as discovery URL.

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
otherthe UaEndpoint to assign.
Returns
Assignment operator.
UaPkiProvider * UaEndpoint::pkiProvider ( ) const

Get the PKI provider.

Returns
the PKI provider of the Endpoint
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
sEndpointUrlthe URL used for the endpoint.
useAlsoAsStackUrltrue if also used false if not.
void UaEndpoint::setIsDiscoveryUrl ( OpcUa_Boolean  isDiscoveryUrl)

Set the flag that indicates if the endpoint URL is provided as discovery URL.

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
serverCertificateServer certificate used for this Endpoint.
serverPrivateKeyServer private key used for this Endpoint.
pPkiProviderPKI provider OpenSSL.
UaStatus UaEndpoint::setSerializerType ( OpcUa_Endpoint_SerializerType  eSerializerType)

Set the serializer type used for the endpoint.

Parameters
eSerializerTypeSerializer type 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.

Parameters
sStackEndpointUrlthe URL for the Endpoint used for the stack.

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