Botan::TLS::Server_Information Class Reference

#include <tls_server_info.h>

Public Member Functions
bool	empty () const
std::string	hostname () const
uint16_t	port () const
	Server_Information ()=default
	Server_Information (std::string_view hostname, std::string_view service, uint16_t port=0)
BOTAN_FUTURE_EXPLICIT	Server_Information (std::string_view hostname, uint16_t port=0)
std::string	service () const

Detailed Description

Represents information known about a TLS server.

Definition at line 19 of file tls_server_info.h.

Constructor & Destructor Documentation

Server_Information() [1/3]

Botan::TLS::Server_Information::Server_Information ( )

default

An empty server info - nothing known

Server_Information() [2/3]

BOTAN_FUTURE_EXPLICIT Botan::TLS::Server_Information::Server_Information ( std::string_view hostname, uint16_t port = 0 )

inline

Parameters

hostname	the host's DNS name, if known
port	specifies the protocol port of the server (eg for TCP/UDP). Zero represents unknown.

Definition at line 31 of file tls_server_info.h.

                                                                                           :
            m_hostname(hostname), m_port(port) {}

References BOTAN_FUTURE_EXPLICIT, hostname(), and port().

Server_Information() [3/3]

Botan::TLS::Server_Information::Server_Information ( std::string_view hostname, std::string_view service, uint16_t port = 0 )

inline

Parameters

hostname	the host's DNS name, if known
service	is a text string of the service type (eg "https", "tor", or "git")
port	specifies the protocol port of the server (eg for TCP/UDP). Zero represents unknown.

Definition at line 41 of file tls_server_info.h.

                                                                                             :
            m_hostname(hostname), m_service(service), m_port(port) {}

References hostname(), port(), and service().

Member Function Documentation

empty()

bool Botan::TLS::Server_Information::empty ( ) const

inline

Returns

whether the hostname is known

Definition at line 63 of file tls_server_info.h.

{ return m_hostname.empty(); }

hostname()

std::string Botan::TLS::Server_Information::hostname ( ) const

inline

Returns

the host's DNS name, if known

Definition at line 47 of file tls_server_info.h.

{ return m_hostname; }

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Session_Manager_SQL::find_some(), Botan::TLS::operator<(), Botan::TLS::operator==(), Server_Information(), Server_Information(), and Botan::TLS::Session_Manager_SQL::store().

port()

uint16_t Botan::TLS::Server_Information::port ( ) const

inline

Returns

the protocol port of the server, or zero if unknown

Definition at line 58 of file tls_server_info.h.

{ return m_port; }

Referenced by Botan::TLS::Session_Manager_SQL::find_some(), Botan::TLS::operator<(), Botan::TLS::operator==(), Server_Information(), Server_Information(), and Botan::TLS::Session_Manager_SQL::store().

service()

std::string Botan::TLS::Server_Information::service ( ) const

inline

Returns

text string of the service type, e.g., "https", "tor", or "git"

Definition at line 53 of file tls_server_info.h.

{ return m_service; }

Referenced by Botan::TLS::operator<(), Botan::TLS::operator==(), and Server_Information().

---

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

• src/lib/tls/tls_server_info.h