#include <client.hpp>

Inheritance diagram for opcua::ClientConfig:

Detailed Description

Client configuration.

See also: UA_ClientConfig

Definition at line 38 of file client.hpp.

Public Member Functions
	ClientConfig ()

	ClientConfig (const ByteString &certificate, const ByteString &privateKey, Span< const ByteString > trustList, Span< const ByteString > revocationList={})

	ClientConfig (UA_ClientConfig &&native) noexcept

	ClientConfig (const ClientConfig &)=delete

	ClientConfig (ClientConfig &&) noexcept=default

ClientConfig &	operator= (const ClientConfig &)=delete

ClientConfig &	operator= (ClientConfig &&)=default

	~ClientConfig () noexcept=default

void	setLogger (LogFunction func)

void	setTimeout (uint32_t milliseconds) noexcept

void	setUserIdentityToken (const AnonymousIdentityToken &token)

void	setUserIdentityToken (const UserNameIdentityToken &token)

void	setUserIdentityToken (const X509IdentityToken &token)

void	setUserIdentityToken (const IssuedIdentityToken &token)

void	setSecurityMode (MessageSecurityMode mode) noexcept

void	addCustomDataTypes (Span< const DataType > types)

Public Member Functions inherited from opcua::Wrapper< UA_ClientConfig >
constexpr	Wrapper () noexcept=default

constexpr	Wrapper (const Wrapper &other)

constexpr	Wrapper (const UA_ClientConfig &native)

constexpr	Wrapper (Wrapper &&other) noexcept

constexpr	Wrapper (UA_ClientConfig &&native) noexcept

	~Wrapper () noexcept=default

constexpr Wrapper &	operator= (const Wrapper &other)

constexpr Wrapper &	operator= (const UA_ClientConfig &native)

constexpr Wrapper &	operator= (Wrapper &&other) noexcept

constexpr Wrapper &	operator= (UA_ClientConfig &&native) noexcept

constexpr	operator UA_ClientConfig & () noexcept

constexpr	operator const UA_ClientConfig & () const noexcept

constexpr UA_ClientConfig *	operator-> () noexcept

constexpr const UA_ClientConfig *	operator-> () const noexcept

constexpr UA_ClientConfig *	handle () noexcept

constexpr const UA_ClientConfig *	handle () const noexcept

constexpr void	swap (Wrapper &other) noexcept

constexpr void	swap (UA_ClientConfig &native) noexcept

Additional Inherited Members
Public Types inherited from opcua::Wrapper< UA_ClientConfig >
using	NativeType = UA_ClientConfig

using	HandlerType = TypeHandler< UA_ClientConfig >

Protected Member Functions inherited from opcua::Wrapper< UA_ClientConfig >
constexpr const UA_ClientConfig &	native () const noexcept

constexpr UA_ClientConfig &	native () noexcept

constexpr void	clear () noexcept

Related Symbols inherited from opcua::Wrapper< UA_ClientConfig >
constexpr UA_ClientConfig *	asWrapper (typename T::NativeType *native) noexcept

constexpr const UA_ClientConfig *	asWrapper (const typename T::NativeType *native) noexcept

constexpr UA_ClientConfig &	asWrapper (typename T::NativeType &native) noexcept

constexpr const UA_ClientConfig &	asWrapper (const typename T::NativeType &native) noexcept

constexpr T::NativeType *	asNative (UA_ClientConfig *wrapper) noexcept

constexpr const T::NativeType *	asNative (const UA_ClientConfig *wrapper) noexcept

constexpr T::NativeType &	asNative (UA_ClientConfig &wrapper) noexcept

constexpr const T::NativeType &	asNative (const UA_ClientConfig &wrapper) noexcept

Constructor & Destructor Documentation

◆ ClientConfig() [1/5]

opcua::ClientConfig::ClientConfig ( )

Create client config with default configuration (no encryption).

Security policies:

None

◆ ClientConfig() [2/5]

opcua::ClientConfig::ClientConfig	(	const ByteString &	certificate,
		const ByteString &	privateKey,
		Span< const ByteString >	trustList,
		Span< const ByteString >	revocationList = `{}`
	)

Create client config with encryption enabled (PKI).

Security policies:

Parameters

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
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/Part6/v105/docs/6.2

◆ ClientConfig() [3/5]

opcua::ClientConfig::ClientConfig ( UA_ClientConfig && native )

inlineexplicitnoexcept

Definition at line 73 of file client.hpp.

◆ ClientConfig() [4/5]

opcua::ClientConfig::ClientConfig ( const ClientConfig & )

delete

◆ ClientConfig() [5/5]

opcua::ClientConfig::ClientConfig ( ClientConfig && )

defaultnoexcept

◆ ~ClientConfig()

opcua::ClientConfig::~ClientConfig ( )

defaultnoexcept

Member Function Documentation

◆ addCustomDataTypes()

void opcua::ClientConfig::addCustomDataTypes ( Span< const DataType > types )

Add custom data types.

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

Examples: custom_datatypes/client_custom_datatypes.cpp.

◆ operator=() [1/2]

ClientConfig & opcua::ClientConfig::operator= ( ClientConfig && )

default

◆ operator=() [2/2]

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

delete

◆ setLogger()

void opcua::ClientConfig::setLogger ( LogFunction func )

Set custom log function.

Does nothing if the passed function is empty or a nullptr.

Examples: client_find_servers.cpp.

◆ setSecurityMode()

void opcua::ClientConfig::setSecurityMode ( MessageSecurityMode mode )

noexcept

Set message security mode.

◆ setTimeout()

void opcua::ClientConfig::setTimeout ( uint32_t milliseconds )

noexcept

Set response timeout in milliseconds.

◆ setUserIdentityToken() [1/4]

void opcua::ClientConfig::setUserIdentityToken ( const AnonymousIdentityToken & token )

Set anonymous identity token.

Examples: client_connect.cpp.

◆ setUserIdentityToken() [2/4]

void opcua::ClientConfig::setUserIdentityToken ( const IssuedIdentityToken & token )

Set issued identity token.

◆ setUserIdentityToken() [3/4]

void opcua::ClientConfig::setUserIdentityToken ( const UserNameIdentityToken & token )

Set username/password identity token.

◆ setUserIdentityToken() [4/4]

void opcua::ClientConfig::setUserIdentityToken ( const X509IdentityToken & token )

Set X.509 identity token.