28#ifndef WEBSOCKETPP_ENDPOINT_HPP
29#define WEBSOCKETPP_ENDPOINT_HPP
31#include <websocketpp/connection.hpp>
33#include <websocketpp/logger/levels.hpp>
34#include <websocketpp/version.hpp>
41template <
typename connection,
typename config>
42class endpoint :
public config::transport_type,
public config::endpoint_base {
80 typedef typename concurrency_type::mutex_type
mutex_type;
86 typedef typename connection_type::termination_handler termination_handler;
92 : m_alog(new
alog_type(config::alog_level, log::channel_type_hint::access))
93 , m_elog(new
elog_type(config::elog_level, log::channel_type_hint::error))
95 , m_open_handshake_timeout_dur(config::timeout_open_handshake)
96 , m_close_handshake_timeout_dur(config::timeout_close_handshake)
97 , m_pong_timeout_dur(config::timeout_pong)
98 , m_max_message_size(config::max_message_size)
99 , m_max_http_body_size(config::max_http_body_size)
100 , m_is_server(p_is_server)
102 m_alog->set_channels(config::alog_level);
103 m_elog->set_channels(config::elog_level);
107 transport_type::init_logging(m_alog, m_elog);
114 #ifdef _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
116 endpoint(endpoint &) =
delete;
119 endpoint & operator=(endpoint
const &) =
delete;
122 #ifdef _WEBSOCKETPP_MOVE_SEMANTICS_
124 endpoint(endpoint && o)
126 , config::endpoint_base(std::move(o))
127 , m_alog(std::move(o.m_alog))
128 , m_elog(std::move(o.m_elog))
129 , m_user_agent(std::move(o.m_user_agent))
130 , m_open_handler(std::move(o.m_open_handler))
132 , m_close_handler(std::move(o.m_close_handler))
133 , m_fail_handler(std::move(o.m_fail_handler))
134 , m_ping_handler(std::move(o.m_ping_handler))
135 , m_pong_handler(std::move(o.m_pong_handler))
136 , m_pong_timeout_handler(std::move(o.m_pong_timeout_handler))
137 , m_interrupt_handler(std::move(o.m_interrupt_handler))
138 , m_http_handler(std::move(o.m_http_handler))
139 , m_validate_handler(std::move(o.m_validate_handler))
140 , m_message_handler(std::move(o.m_message_handler))
142 , m_open_handshake_timeout_dur(o.m_open_handshake_timeout_dur)
143 , m_close_handshake_timeout_dur(o.m_close_handshake_timeout_dur)
144 , m_pong_timeout_dur(o.m_pong_timeout_dur)
145 , m_max_message_size(o.m_max_message_size)
146 , m_max_http_body_size(o.m_max_http_body_size)
148 , m_rng(std::move(o.m_rng))
149 , m_is_server(o.m_is_server)
152 #ifdef _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
154 endpoint & operator=(endpoint &&) =
delete;
221 m_alog->set_channels(channels);
232 m_alog->clear_channels(channels);
243 m_elog->set_channels(channels);
254 m_elog->clear_channels(channels);
305 m_pong_timeout_handler = h;
310 m_interrupt_handler = h;
320 m_validate_handler = h;
325 m_message_handler = h;
354 m_open_handshake_timeout_dur = dur;
379 m_close_handshake_timeout_dur = dur;
401 m_pong_timeout_dur = dur;
416 return m_max_message_size;
433 m_max_message_size = new_value;
450 return m_max_http_body_size;
467 m_max_http_body_size = new_value;
561 frame::opcode::value op, lib::error_code & ec);
572 frame::opcode::value op);
575 frame::opcode::value op, lib::error_code & ec);
577 frame::opcode::value op);
583 std::string
const & reason, lib::error_code & ec);
585 std::string
const & reason);
596 lib::error_code & ec);
617 lib::error_code & ec);
664 lib::shared_ptr<alog_type> m_alog;
665 lib::shared_ptr<elog_type> m_elog;
668 std::string m_user_agent;
681 long m_open_handshake_timeout_dur;
682 long m_close_handshake_timeout_dur;
683 long m_pong_timeout_dur;
684 size_t m_max_message_size;
685 size_t m_max_http_body_size;
690 bool const m_is_server;
698#include <websocketpp/impl/endpoint_impl.hpp>
Represents an individual WebSocket connection.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection.
lib::weak_ptr< type > weak_ptr
Type of a weak pointer to this connection.
Creates and manages connections associated with a WebSocket endpoint.
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
void set_user_agent(std::string const &ua)
Sets the user agent string that this endpoint will use.
connection_ptr get_con_from_hdl(connection_hdl hdl, lib::error_code &ec)
Retrieves a connection_ptr from a connection_hdl (exception free)
config::concurrency_type concurrency_type
Type of the concurrency component of this endpoint.
config::alog_type alog_type
Type of access logger.
void ping(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a ping to a specific connection.
alog_type & get_alog()
Get reference to access logger.
transport_con_type::ptr transport_con_ptr
std::string get_user_agent() const
Returns the user agent string that this endpoint will use.
void clear_access_channels(log::level channels)
Clear Access logging channels.
config::elog_type elog_type
Type of error logger.
elog_type & get_elog()
Get reference to error logger.
bool is_server() const
Returns whether or not this endpoint is a server.
void send(connection_hdl hdl, std::string const &payload, frame::opcode::value op, lib::error_code &ec)
Create a message and add it to the outgoing send queue (exception free)
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
connection_type::message_ptr message_ptr
Type of message pointers that this endpoint uses.
void pong(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a pong to a specific connection.
void set_access_channels(log::level channels)
Set Access logging channel.
void set_max_message_size(size_t new_value)
Set default maximum message size.
size_t get_max_message_size() const
Get default maximum message size.
connection_ptr get_con_from_hdl(connection_hdl hdl)
Retrieves a connection_ptr from a connection_hdl (exception version)
connection connection_type
Type of the connections that this endpoint creates.
void set_error_channels(log::level channels)
Set Error logging channel.
config::transport_type transport_type
Type of the transport component of this endpoint.
void clear_error_channels(log::level channels)
Clear Error logging channels.
void resume_reading(connection_hdl hdl, lib::error_code &ec)
Resume reading of new data (exception free)
connection_type::ptr connection_ptr
Shared pointer to connection_type.
transport_type::transport_con_type transport_con_type
concurrency_type::mutex_type mutex_type
Type of our concurrency policy's mutex object.
void interrupt(connection_hdl hdl, lib::error_code &ec)
void set_pong_timeout(long dur)
Set pong timeout.
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
config::rng_type rng_type
Type of RNG.
concurrency_type::scoped_lock_type scoped_lock_type
Type of our concurrency policy's scoped lock object.
void send_http_response(connection_hdl hdl, lib::error_code &ec)
Send deferred HTTP Response.
void pause_reading(connection_hdl hdl, lib::error_code &ec)
Pause reading of new data (exception free)
connection_type::message_handler message_handler
Type of message_handler.
connection_type::weak_ptr connection_weak_ptr
Weak pointer to connection type.
uint16_t value
The type of a close code value.
Namespace for the WebSocket++ project.
lib::function< void(connection_hdl, std::string)> pong_handler
The type and function signature of a pong handler.
lib::function< void(connection_hdl)> close_handler
The type and function signature of a close handler.
lib::function< void(connection_hdl, std::string)> pong_timeout_handler
The type and function signature of a pong timeout handler.
lib::function< void(connection_hdl)> http_handler
The type and function signature of a http handler.
lib::function< void(connection_hdl)> open_handler
The type and function signature of an open handler.
lib::function< void(connection_hdl)> interrupt_handler
The type and function signature of an interrupt handler.
lib::function< void(connection_hdl)> fail_handler
The type and function signature of a fail handler.
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
lib::function< bool(connection_hdl, std::string)> ping_handler
The type and function signature of a ping handler.
static char const user_agent[]
Default user agent string.
lib::function< bool(connection_hdl)> validate_handler
The type and function signature of a validate handler.
static level const devel
Development messages (warning: very chatty)