join::Tls Class Reference

SSL/TLS protocol class. More...

#include <protocol.hpp>

Public Types
using	Endpoint = BasicInternetEndpoint <Tls>
using	Socket = BasicTlsSocket <Tls>
using	Stream = BasicTlsStream <Tls>
using	Acceptor = BasicTlsAcceptor <Tls>

Public Member Functions
constexpr	Tls (int family=AF_INET) noexcept
	create the tcp protocol instance.
constexpr int	family () const noexcept
	get the protocol IP address family.
constexpr int	type () const noexcept
	get the protocol communication semantic.
constexpr int	protocol () const noexcept
	get the protocol type.

Static Public Member Functions
static Tls &	v4 () noexcept
	get protocol suitable for IPv4 address family.
static Tls &	v6 () noexcept
	get protocol suitable for IPv6 address family.

Detailed Description

SSL/TLS protocol class.

Member Typedef Documentation

Acceptor

using join::Tls::Acceptor = BasicTlsAcceptor <Tls>

Endpoint

using join::Tls::Endpoint = BasicInternetEndpoint <Tls>

Socket

using join::Tls::Socket = BasicTlsSocket <Tls>

Stream

using join::Tls::Stream = BasicTlsStream <Tls>

Constructor & Destructor Documentation

Tls()

join::Tls::Tls ( int family = AF_INET )

inlineconstexprnoexcept

create the tcp protocol instance.

Parameters

family

IP address family.

Member Function Documentation

family()

int join::Tls::family ( ) const

inlineconstexprnoexcept

get the protocol IP address family.

Returns

the protocol IP address family.

protocol()

int join::Tls::protocol ( ) const

inlineconstexprnoexcept

get the protocol type.

Returns

the protocol type.

type()

int join::Tls::type ( ) const

inlineconstexprnoexcept

get the protocol communication semantic.

Returns

the protocol communication semantic.

v4()

static Tls & join::Tls::v4 ( )

inlinestaticnoexcept

get protocol suitable for IPv4 address family.

Returns

an IPv4 address family suitable protocol.

v6()

static Tls & join::Tls::v6 ( )

inlinestaticnoexcept

get protocol suitable for IPv6 address family.

Returns

an IPv6 address family suitable protocol.

---

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

• core/include/join/protocol.hpp