WebSocket++  0.8.3-dev
C++ websocket client/server library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
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

bool is_secure () const
 Checks whether the endpoint creates secure connections. More...
 
void set_socket_init_handler (socket_init_handler h)
 Set socket init handler. More...
 

Protected Member Functions

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

Detailed Description

Basic ASIO endpoint socket component.

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

Definition at line 317 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 326 of file none.hpp.

Member Function Documentation

◆ init()

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

Initialize a connection.

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 359 of file none.hpp.

◆ is_secure()

bool websocketpp::transport::asio::basic_socket::endpoint::is_secure ( ) const
inline

Checks whether the endpoint creates secure connections.

Returns
Whether or not the endpoint creates secure connections

Definition at line 334 of file none.hpp.

◆ set_socket_init_handler()

void websocketpp::transport::asio::basic_socket::endpoint::set_socket_init_handler ( socket_init_handler  h)
inline

Set socket init handler.

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 346 of file none.hpp.


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