websocketpp::transport::asio::tls_socket::endpoint Class Reference

TLS enabled Asio endpoint socket component. More...

#include <tls.hpp>

Public Types
typedef endpoint	type
	The type of this endpoint socket component.
typedef connection	socket_con_type
	The type of the corresponding connection socket component.
typedef socket_con_type::ptr	socket_con_ptr

Public Member Functions
	endpoint ()
bool	is_secure () const
	Checks whether the endpoint creates secure connections.
void	set_socket_init_handler (socket_init_handler h)
	Set socket init handler.
void	set_tls_init_handler (tls_init_handler h)
	Set TLS init handler.

Protected Member Functions
lib::error_code	init (socket_con_ptr scon)
	Initialize a connection.

Detailed Description

transport::asio::tls_socket::endpoint implements a secure endpoint socket component that uses Asio's ssl::stream to wrap an ip::tcp::socket.

Definition at line 408 of file tls.hpp.

Member Typedef Documentation

socket_con_ptr

socket_con_type::ptr websocketpp::transport::asio::tls_socket::endpoint::socket_con_ptr

The type of a shared pointer to the corresponding connection socket component.

Definition at line 417 of file tls.hpp.

socket_con_type

connection websocketpp::transport::asio::tls_socket::endpoint::socket_con_type

Definition at line 414 of file tls.hpp.

type

endpoint websocketpp::transport::asio::tls_socket::endpoint::type

Definition at line 411 of file tls.hpp.

Constructor & Destructor Documentation

endpoint()

websocketpp::transport::asio::tls_socket::endpoint::endpoint ( )

inlineexplicit

Definition at line 419 of file tls.hpp.

{}

Member Function Documentation

init()

lib::error_code websocketpp::transport::asio::tls_socket::endpoint::init ( socket_con_ptr scon )

inlineprotected

Called by the transport after a new connection is created to initialize the socket component of the connection.

Parameters

scon	Pointer to the socket component of the connection

Returns

Error code (empty on success)

Definition at line 463 of file tls.hpp.

                                            {
        scon->set_socket_init_handler(m_socket_init_handler);
        scon->set_tls_init_handler(m_tls_init_handler);
        return lib::error_code();
    }

is_secure()

bool websocketpp::transport::asio::tls_socket::endpoint::is_secure ( ) const

inline

Returns

Whether or not the endpoint creates secure connections

Definition at line 425 of file tls.hpp.

                           {
        return true;
    }

set_socket_init_handler()

void websocketpp::transport::asio::tls_socket::endpoint::set_socket_init_handler ( socket_init_handler h )

inline

The socket init handler is called after a connection's socket is created but before it is used. This gives the end application an opportunity to set asio socket specific parameters.

Parameters

h	The new socket_init_handler

Definition at line 437 of file tls.hpp.

                                                        {
        m_socket_init_handler = h;
    }

set_tls_init_handler()

void websocketpp::transport::asio::tls_socket::endpoint::set_tls_init_handler ( tls_init_handler h )

inline

The tls init handler is called when needed to request a TLS context for the library to use. A TLS init handler must be set and it must return a valid TLS context in order for this endpoint to be able to initialize TLS connections

Parameters

h	The new tls_init_handler

Definition at line 450 of file tls.hpp.

                                                  {
        m_tls_init_handler = h;
    }

---

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

• libraries/fc/vendor/websocketpp/websocketpp/transport/asio/security/tls.hpp