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>
41 template <
typename connection,
typename config>
42 class 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;
89 : m_alog(config::alog_level, log::channel_type_hint::access)
90 , m_elog(config::elog_level, log::channel_type_hint::error)
92 , m_open_handshake_timeout_dur(config::timeout_open_handshake)
93 , m_close_handshake_timeout_dur(config::timeout_close_handshake)
94 , m_pong_timeout_dur(config::timeout_pong)
95 , m_max_message_size(config::max_message_size)
96 , m_max_http_body_size(config::max_http_body_size)
97 , m_is_server(p_is_server)
99 m_alog.set_channels(config::alog_level);
100 m_elog.set_channels(config::elog_level);
104 transport_type::init_logging(&m_alog, &m_elog);
111 #ifdef _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
117 #endif // _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
119 #ifdef _WEBSOCKETPP_MOVE_SEMANTICS_
122 : config::transport_type(
std::move(o))
124 , m_alog(
std::move(o.m_alog))
125 , m_elog(
std::move(o.m_elog))
126 , m_user_agent(
std::move(o.m_user_agent))
127 , m_open_handler(
std::move(o.m_open_handler))
129 , m_close_handler(
std::move(o.m_close_handler))
130 , m_fail_handler(
std::move(o.m_fail_handler))
131 , m_ping_handler(
std::move(o.m_ping_handler))
132 , m_pong_handler(
std::move(o.m_pong_handler))
133 , m_pong_timeout_handler(
std::move(o.m_pong_timeout_handler))
134 , m_interrupt_handler(
std::move(o.m_interrupt_handler))
135 , m_http_handler(
std::move(o.m_http_handler))
136 , m_validate_handler(
std::move(o.m_validate_handler))
137 , m_message_handler(
std::move(o.m_message_handler))
139 , m_open_handshake_timeout_dur(o.m_open_handshake_timeout_dur)
140 , m_close_handshake_timeout_dur(o.m_close_handshake_timeout_dur)
141 , m_pong_timeout_dur(o.m_pong_timeout_dur)
142 , m_max_message_size(o.m_max_message_size)
143 , m_max_http_body_size(o.m_max_http_body_size)
145 , m_rng(
std::move(o.m_rng))
146 , m_is_server(o.m_is_server)
149 #ifdef _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
151 endpoint & operator=(endpoint &&) =
delete;
152 #endif // _WEBSOCKETPP_DEFAULT_DELETE_FUNCTIONS_
154 #endif // _WEBSOCKETPP_MOVE_SEMANTICS_
167 scoped_lock_type guard(m_mutex);
194 scoped_lock_type guard(m_mutex);
218 m_alog.set_channels(channels);
229 m_alog.clear_channels(channels);
240 m_elog.set_channels(channels);
251 m_elog.clear_channels(channels);
276 scoped_lock_type guard(m_mutex);
281 scoped_lock_type guard(m_mutex);
286 scoped_lock_type guard(m_mutex);
291 scoped_lock_type guard(m_mutex);
296 scoped_lock_type guard(m_mutex);
301 scoped_lock_type guard(m_mutex);
302 m_pong_timeout_handler = h;
306 scoped_lock_type guard(m_mutex);
307 m_interrupt_handler = h;
311 scoped_lock_type guard(m_mutex);
316 scoped_lock_type guard(m_mutex);
317 m_validate_handler = h;
319 void set_message_handler(message_handler h) {
321 scoped_lock_type guard(m_mutex);
322 m_message_handler = h;
350 scoped_lock_type guard(m_mutex);
351 m_open_handshake_timeout_dur = dur;
375 scoped_lock_type guard(m_mutex);
376 m_close_handshake_timeout_dur = dur;
397 scoped_lock_type guard(m_mutex);
398 m_pong_timeout_dur = dur;
413 return m_max_message_size;
430 m_max_message_size = new_value;
447 return m_max_http_body_size;
464 m_max_http_body_size = new_value;
558 frame::opcode::value op, lib::error_code & ec);
569 frame::opcode::value op);
572 frame::opcode::value op, lib::error_code & ec);
574 frame::opcode::value op);
580 std::string
const & reason, lib::error_code & ec);
582 std::string
const & reason);
593 lib::error_code & ec);
614 lib::error_code & ec);
641 connection_ptr con = lib::static_pointer_cast<connection_type>(
659 connection_ptr create_connection();
665 std::string m_user_agent;
676 message_handler m_message_handler;
678 long m_open_handshake_timeout_dur;
679 long m_close_handshake_timeout_dur;
680 long m_pong_timeout_dur;
681 size_t m_max_message_size;
682 size_t m_max_http_body_size;
687 bool const m_is_server;
690 mutable mutex_type m_mutex;
695 #include <websocketpp/impl/endpoint_impl.hpp>
697 #endif // WEBSOCKETPP_ENDPOINT_HPP
void send_http_response(connection_hdl hdl, lib::error_code &ec)
Send deferred HTTP Response.
config::concurrency_type concurrency_type
Type of the concurrency component of this endpoint.
uint16_t value
The type of a close code value.
size_t get_max_message_size() const
Get default maximum message size.
bool is_server() const
Returns whether or not this endpoint is a server.
lib::function< void(connection_hdl)> close_handler
The type and function signature of a close handler.
lib::function< void(connection_hdl)> open_handler
The type and function signature of an open handler.
void ping(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a ping to a specific connection.
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)> interrupt_handler
The type and function signature of an interrupt handler.
config::rng_type rng_type
Type of RNG.
lib::function< bool(connection_hdl, std::string)> ping_handler
The type and function signature of a ping handler.
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
lib::weak_ptr< type > weak_ptr
Type of a weak pointer to this connection.
Represents an individual WebSocket connection.
connection_type::message_ptr message_ptr
Type of message pointers that this endpoint uses.
void interrupt(connection_hdl hdl, lib::error_code &ec)
connection_type::message_handler message_handler
Type of message_handler.
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
transport_con_type::ptr transport_con_ptr
alog_type & get_alog()
Get reference to access logger.
static char const user_agent[]
Default user agent string.
connection_ptr get_con_from_hdl(connection_hdl hdl, lib::error_code &ec)
Retrieves a connection_ptr from a connection_hdl (exception free)
concurrency_type::scoped_lock_type scoped_lock_type
Type of our concurrency policy's scoped lock object.
void pause_reading(connection_hdl hdl, lib::error_code &ec)
Pause reading of new data (exception free)
std::string get_user_agent() const
Returns the user agent string that this endpoint will use.
static level const devel
Development messages (warning: very chatty)
concurrency_type::mutex_type mutex_type
Type of our concurrency policy's mutex object.
void resume_reading(connection_hdl hdl, lib::error_code &ec)
Resume reading of new data (exception free)
lib::function< bool(connection_hdl)> validate_handler
The type and function signature of a validate handler.
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
void set_max_message_size(size_t new_value)
Set default maximum message size.
transport_type::transport_con_type transport_con_type
config::alog_type alog_type
Type of access logger.
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
config::transport_type transport_type
Type of the transport component of this endpoint.
connection_type::ptr connection_ptr
Shared pointer to connection_type.
Stub for user supplied base class.
lib::function< void(connection_hdl)> http_handler
The type and function signature of a http handler.
void pong(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a pong to a specific connection.
void clear_error_channels(log::level channels)
Clear Error logging channels.
void set_access_channels(log::level channels)
Set Access logging channel.
Namespace for the WebSocket++ project.
elog_type & get_elog()
Get reference to error logger.
config::elog_type elog_type
Type of error logger.
Creates and manages connections associated with a WebSocket endpoint.
connection_type::weak_ptr connection_weak_ptr
Weak pointer to connection type.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection.
connection connection_type
Type of the connections that this endpoint creates.
void clear_access_channels(log::level channels)
Clear Access logging channels.
void set_error_channels(log::level channels)
Set Error logging channel.
void set_pong_timeout(long dur)
Set pong timeout.
lib::function< void(connection_hdl, std::string)> pong_handler
The type and function signature of a pong handler.
connection_ptr get_con_from_hdl(connection_hdl hdl)
Retrieves a connection_ptr from a connection_hdl (exception version)
void set_user_agent(std::string const &ua)
Sets the user agent string that this endpoint will use.
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)
lib::function< void(connection_hdl)> fail_handler
The type and function signature of a fail handler.