Wire Sysio Wire Sysion 1.0.0
Loading...
Searching...
No Matches
websocketpp::transport::asio::basic_socket::endpoint Class Reference

Basic ASIO endpoint socket component. More...

#include <none.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.
 

Protected Member Functions

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

Detailed Description

transport::asio::basic_socket::endpoint implements an endpoint socket component that uses Boost ASIO's ip::tcp::socket.

Definition at line 314 of file none.hpp.

Member Typedef Documentation

◆ socket_con_ptr

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

Definition at line 323 of file none.hpp.

◆ socket_con_type

◆ type

Constructor & Destructor Documentation

◆ endpoint()

websocketpp::transport::asio::basic_socket::endpoint::endpoint ( )
inlineexplicit

Definition at line 325 of file none.hpp.

325{}

Member Function Documentation

◆ init()

lib::error_code websocketpp::transport::asio::basic_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
sconPointer to the socket component of the connection
Returns
Error code (empty on success)

Definition at line 356 of file none.hpp.

356 {
357 scon->set_socket_init_handler(m_socket_init_handler);
358 return lib::error_code();
359 }

◆ is_secure()

bool websocketpp::transport::asio::basic_socket::endpoint::is_secure ( ) const
inline
Returns
Whether or not the endpoint creates secure connections

Definition at line 331 of file none.hpp.

331 {
332 return false;
333 }

◆ set_socket_init_handler()

void websocketpp::transport::asio::basic_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
hThe new socket_init_handler

Definition at line 343 of file none.hpp.

343 {
344 m_socket_init_handler = h;
345 }

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