CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
TlsClientOptions Class Referencefinal

TLS client credentials and connection parameters. More...

#include <cc/TlsClientOptions>

Inheritance diagram for TlsClientOptions:

Public Member Functions

 TlsClientOptions ()=default
 Create primordial security credentials.
 
void setServerName (const String &serverName)
 Provide the server name the client is expecting to connect to.
 
void setCredentials (const String &certPath, const String &keyPath)
 Set client authetification credentials
 
void setTrustFilePath (const String &filePath)
 Set custom trust file path
 
void setCiphers (const String &ciphers)
 Set allowed ciphers
 
String serverName () const
 Server name the client is expecting to connect to.
 
String certPath () const
 Certificate file path for client authentification.
 
String keyPath () const
 Private key for client authentification.
 
String trustFilePath () const
 Custome trust file path.
 
String ciphers () const
 Allowed ciphers.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Additional Inherited Members

- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

TLS client credentials and connection parameters.

Constructor & Destructor Documentation

◆ TlsClientOptions()

TlsClientOptions ( )
default

Create primordial security credentials.

Member Function Documentation

◆ setServerName()

void setServerName ( const String & serverName)

Provide the server name the client is expecting to connect to.

◆ setCredentials()

void setCredentials ( const String & certPath,
const String & keyPath )

Set client authetification credentials

Parameters
certPathCertificate file path
keyPathPrivate key file path

◆ setTrustFilePath()

void setTrustFilePath ( const String & filePath)

Set custom trust file path

◆ setCiphers()

void setCiphers ( const String & ciphers)

Set allowed ciphers

◆ serverName()

String serverName ( ) const

Server name the client is expecting to connect to.

◆ certPath()

String certPath ( ) const

Certificate file path for client authentification.

◆ keyPath()

String keyPath ( ) const

Private key for client authentification.

◆ trustFilePath()

String trustFilePath ( ) const

Custome trust file path.

◆ ciphers()

String ciphers ( ) const

Allowed ciphers.