opcua::ServerConfig Class Reference

#include <server.hpp>

Inheritance diagram for opcua::ServerConfig:

Detailed Description

Server configuration.

See also

UA_ServerConfig

Examples

server.cpp, server_accesscontrol.cpp, and server_logger.cpp.

Definition at line 43 of file server.hpp.

Public Member Functions
	ServerConfig ()
	ServerConfig (uint16_t port, const ByteString &certificate={})
	ServerConfig (uint16_t port, const ByteString &certificate, const ByteString &privateKey, Span< const ByteString > trustList, Span< const ByteString > issuerList, Span< const ByteString > revocationList={})
	ServerConfig (UA_ServerConfig &&native)
	ServerConfig (const ServerConfig &)=delete
	ServerConfig (ServerConfig &&) noexcept=default
ServerConfig &	operator= (const ServerConfig &)=delete
ServerConfig &	operator= (ServerConfig &&) noexcept=default
	~ServerConfig () noexcept=default
void	setLogger (LogFunction func)
void	setBuildInfo (BuildInfo buildInfo)
void	setApplicationUri (std::string_view uri)
void	setProductUri (std::string_view uri)
void	setApplicationName (std::string_view name)
void	addCustomDataTypes (Span< const DataType > types)
void	setAccessControl (AccessControlBase &accessControl)
void	setAccessControl (std::unique_ptr< AccessControlBase > &&accessControl)
Public Member Functions inherited from opcua::Wrapper< UA_ServerConfig >
constexpr	Wrapper () noexcept=default
constexpr	Wrapper (const Wrapper &other)
constexpr	Wrapper (const UA_ServerConfig &native)
constexpr	Wrapper (Wrapper &&other) noexcept
constexpr	Wrapper (UA_ServerConfig &&native) noexcept
	~Wrapper () noexcept=default
constexpr Wrapper &	operator= (const Wrapper &other)
constexpr Wrapper &	operator= (const UA_ServerConfig &native)
constexpr Wrapper &	operator= (Wrapper &&other) noexcept
constexpr Wrapper &	operator= (UA_ServerConfig &&native) noexcept
constexpr	operator UA_ServerConfig & () noexcept
constexpr	operator const UA_ServerConfig & () const noexcept
constexpr UA_ServerConfig *	operator-> () noexcept
constexpr const UA_ServerConfig *	operator-> () const noexcept
constexpr UA_ServerConfig *	handle () noexcept
constexpr const UA_ServerConfig *	handle () const noexcept
constexpr void	swap (Wrapper &other) noexcept
constexpr void	swap (UA_ServerConfig &native) noexcept

Additional Inherited Members
Public Types inherited from opcua::Wrapper< UA_ServerConfig >
using	NativeType = UA_ServerConfig
using	HandlerType = TypeHandler< UA_ServerConfig >
Protected Member Functions inherited from opcua::Wrapper< UA_ServerConfig >
constexpr const UA_ServerConfig &	native () const noexcept
constexpr UA_ServerConfig &	native () noexcept
constexpr void	clear () noexcept
Related Symbols inherited from opcua::Wrapper< UA_ServerConfig >
constexpr UA_ServerConfig *	asWrapper (typename T::NativeType *native) noexcept
constexpr const UA_ServerConfig *	asWrapper (const typename T::NativeType *native) noexcept
constexpr UA_ServerConfig &	asWrapper (typename T::NativeType &native) noexcept
constexpr const UA_ServerConfig &	asWrapper (const typename T::NativeType &native) noexcept
constexpr T::NativeType *	asNative (UA_ServerConfig *wrapper) noexcept
constexpr const T::NativeType *	asNative (const UA_ServerConfig *wrapper) noexcept
constexpr T::NativeType &	asNative (UA_ServerConfig &wrapper) noexcept
constexpr const T::NativeType &	asNative (const UA_ServerConfig &wrapper) noexcept

Constructor & Destructor Documentation

ServerConfig() [1/6]

opcua::ServerConfig::ServerConfig

(

)

Create server config with default configuration.

Security policies:

• None

ServerConfig() [2/6]

opcua::ServerConfig::ServerConfig ( uint16_t  port, const ByteString &  certificate = {}  )

explicit

Create server config with minimal configuration.

Security policies:

• None

Parameters

port	Port number
certificate	Optional X.509 v3 certificate in DER encoded format

ServerConfig() [3/6]

opcua::ServerConfig::ServerConfig	(	uint16_t	port,
		const ByteString &	certificate,
		const ByteString &	privateKey,
		Span< const ByteString >	trustList,
		Span< const ByteString >	issuerList,
		Span< const ByteString >	revocationList = {}
	)

Create server config with encryption enabled (PKI).

Security policies:

• None
• Basic128Rsa15
• Basic256
• Basic256Sha256
• Aes128_Sha256_RsaOaep

Parameters

port	Port number
certificate	X.509 v3 certificate in DER encoded format
privateKey	Private key in PEM encoded format
trustList	List of trusted certificates in DER encoded format
issuerList	List of issuer certificates (i.e. CAs) in DER encoded format
revocationList	Certificate revocation lists (CRL) in DER encoded format

See also

https://reference.opcfoundation.org/Core/Part2/v105/docs/9

https://reference.opcfoundation.org/Core/Part4/v105/docs/6.1

https://reference.opcfoundation.org/Core/Part6/v105/docs/6.2

ServerConfig() [4/6]

opcua::ServerConfig::ServerConfig ( UA_ServerConfig &&  native )

inlineexplicit

Definition at line 93 of file server.hpp.

ServerConfig() [5/6]

opcua::ServerConfig::ServerConfig ( const ServerConfig &  )

delete

ServerConfig() [6/6]

opcua::ServerConfig::ServerConfig ( ServerConfig &&  )

defaultnoexcept

~ServerConfig()

opcua::ServerConfig::~ServerConfig ( )

defaultnoexcept

Member Function Documentation

addCustomDataTypes()

void opcua::ServerConfig::addCustomDataTypes

(

Span< const DataType >

types

)

Add custom data types.

All data types provided are automatically considered for decoding of received messages.

Examples

custom_datatypes/server_custom_datatypes.cpp.

Referenced by opcua::Server::setCustomDataTypes().

operator=() [1/2]

ServerConfig & opcua::ServerConfig::operator= ( const ServerConfig &  )

delete

operator=() [2/2]

ServerConfig & opcua::ServerConfig::operator= ( ServerConfig &&  )

defaultnoexcept

setAccessControl() [1/2]

void opcua::ServerConfig::setAccessControl

(

AccessControlBase &

accessControl

)

Set custom access control.

Examples

server_accesscontrol.cpp.

setAccessControl() [2/2]

void opcua::ServerConfig::setAccessControl

(

std::unique_ptr< AccessControlBase > &&

accessControl

)

Set custom access control (transfer ownership to Server).

setApplicationName()

void opcua::ServerConfig::setApplicationName

(

std::string_view

name

)

Set application name, default: open62541-based OPC UA Application.

Examples

server.cpp.

setApplicationUri()

void opcua::ServerConfig::setApplicationUri

(

std::string_view

uri

)

Set application URI, default: urn:open62541.server.application.

Examples

server.cpp.

setBuildInfo()

void opcua::ServerConfig::setBuildInfo

(

BuildInfo

buildInfo

)

setLogger()

void opcua::ServerConfig::setLogger

(

LogFunction

func

)

Examples

server_logger.cpp.

setProductUri()

void opcua::ServerConfig::setProductUri

(

std::string_view

uri

)

Set product URI, default: http://open62541.org.

Examples

server.cpp.