2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
28#ifndef WEBSOCKETPP_CONNECTION_IMPL_HPP
29#define WEBSOCKETPP_CONNECTION_IMPL_HPP
31#include <websocketpp/processors/hybi00.hpp>
32#include <websocketpp/processors/hybi07.hpp>
33#include <websocketpp/processors/hybi08.hpp>
34#include <websocketpp/processors/hybi13.hpp>
36#include <websocketpp/processors/processor.hpp>
38#include <websocketpp/common/platforms.hpp>
39#include <websocketpp/common/system_error.hpp>
50namespace istate = session::internal_state;
52template <
typename config>
54 termination_handler new_handler)
57 "connection set_termination_handler");
61 m_termination_handler = new_handler;
64template <
typename config>
70 return m_processor->get_origin(m_request);
73template <
typename config>
76 return m_send_buffer_size;
79template <
typename config>
85template <
typename config>
86lib::error_code
connection<config>::send(std::string
const & payload,
89 message_ptr msg = m_msg_manager->get_message(op,payload.size());
90 msg->append_payload(payload);
91 msg->set_compressed(
true);
96template <
typename config>
100 message_ptr msg = m_msg_manager->get_message(op,len);
101 msg->append_payload(payload,len);
106template <
typename config>
107lib::error_code
connection<config>::
send(
typename config::message_type::ptr msg)
114 scoped_lock_type lock(m_connection_state_lock);
115 if (m_state != session::state::open) {
120 message_ptr outgoing_msg;
121 bool needs_writing =
false;
123 if (msg->get_prepared()) {
126 scoped_lock_type lock(m_write_lock);
127 write_push(outgoing_msg);
128 needs_writing = !m_write_flag && !m_send_queue.empty();
130 outgoing_msg = m_msg_manager->get_message();
136 scoped_lock_type lock(m_write_lock);
137 lib::error_code ec = m_processor->prepare_data_frame(msg,outgoing_msg);
143 write_push(outgoing_msg);
144 needs_writing = !m_write_flag && !m_send_queue.empty();
154 return lib::error_code();
157template <
typename config>
158void connection<config>::ping(std::string
const& payload, lib::error_code& ec) {
164 scoped_lock_type lock(m_connection_state_lock);
165 if (m_state != session::state::open) {
166 std::stringstream ss;
167 ss <<
"connection::ping called from invalid state " << m_state;
174 message_ptr msg = m_msg_manager->get_message();
180 ec = m_processor->prepare_ping(payload,msg);
184 if (m_pong_timeout_handler) {
187 m_ping_timer->cancel();
190 if (m_pong_timeout_dur > 0) {
194 &
type::handle_pong_timeout,
197 lib::placeholders::_1
204 m_elog->write(log
::elevel::warn,
"Warning: a pong_timeout_handler is \
205 set but the transport in use does not support timeouts.");
209 bool needs_writing =
false;
211 scoped_lock_type lock(m_write_lock);
213 needs_writing = !m_write_flag && !m_send_queue.empty();
223 ec = lib::error_code();
226#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
227template<
typename config>
237template<
typename config>
238void connection<config>::handle_pong_timeout(std::string payload,
239 lib::error_code
const & ec)
251 if (m_pong_timeout_handler) {
252 m_pong_timeout_handler(m_connection_hdl,payload);
256template <
typename config>
257void connection<config>::pong(std::string
const& payload, lib::error_code& ec) {
263 scoped_lock_type lock(m_connection_state_lock);
264 if (m_state != session::state::open) {
265 std::stringstream ss;
266 ss <<
"connection::pong called from invalid state " << m_state;
273 message_ptr msg = m_msg_manager->get_message();
279 ec = m_processor->prepare_pong(payload,msg);
282 bool needs_writing =
false;
284 scoped_lock_type lock(m_write_lock);
286 needs_writing = !m_write_flag && !m_send_queue.empty();
296 ec = lib::error_code();
299#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
300template<
typename config>
310template <
typename config>
312 std::string
const & reason, lib::error_code & ec)
319 std::string tr(reason,0,std::min<size_t>(reason.size(),
320 frame::limits::close_reason_size));
322 scoped_lock_type lock(m_connection_state_lock);
324 if (m_state != session::state::open) {
332#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
333template<
typename config>
335 std::string
const & reason)
338 close(code,reason,ec);
347
348
349template <
typename config>
361template <
typename config>
363 if (m_interrupt_handler) {
364 m_interrupt_handler(m_connection_hdl);
368template <
typename config>
370 m_alog->write(log
::alevel::devel,
"connection connection::pause_reading");
380template <
typename config>
382 m_alog->write(log
::alevel::devel,
"connection connection::handle_pause_reading");
386template <
typename config>
388 m_alog->write(log
::alevel::devel,
"connection connection::resume_reading");
398template <
typename config>
414template <
typename config>
417 return m_uri->get_secure();
420template <
typename config>
423 return m_uri->get_host();
426template <
typename config>
429 return m_uri->get_resource();
432template <
typename config>
435 return m_uri->get_port();
438template <
typename config>
444template <
typename config>
455template <
typename config>
457 return m_subprotocol;
460template <
typename config>
463 return m_requested_subprotocols;
466template <
typename config>
467void connection<config>::add_subprotocol(std::string
const & value,
468 lib::error_code & ec)
476 if (value.empty() || std::find_if(value.begin(),value.end(),
483 m_requested_subprotocols.push_back(value);
486#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
487template <
typename config>
488void connection<config>::add_subprotocol(std::string
const & value) {
490 this->add_subprotocol(value,ec);
498template <
typename config>
499void connection<config>::select_subprotocol(std::string
const & value,
500 lib::error_code & ec)
508 ec = lib::error_code();
512 std::vector<std::string>::iterator it;
514 it = std::find(m_requested_subprotocols.begin(),
515 m_requested_subprotocols.end(),
518 if (it == m_requested_subprotocols.end()) {
523 m_subprotocol = value;
524 ec = lib::error_code();
527#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
528template <
typename config>
529void connection<config>::select_subprotocol(std::string
const & value) {
531 this->select_subprotocol(value,ec);
539template <
typename config>
541connection<config>::get_request_header(std::string
const & key)
const {
542 return m_request.get_header(key);
545template <
typename config>
548 return m_request.get_body();
551template <
typename config>
553connection<config>::get_response_header(std::string
const & key)
const {
554 return m_response.get_header(key);
557template <
typename config>
559 lib::error_code & ec)
561 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
565 ec = m_response.set_status(code);
568#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
569template <
typename config>
573 this->set_status(code, ec);
575 throw exception(
"Call to set_status from invalid state", ec);
580template <
typename config>
582 std::string
const & msg, lib::error_code & ec)
584 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
589 ec = m_response.set_status(code,msg);
592#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
593template <
typename config>
595 std::string
const & msg)
598 this->set_status(code, msg, ec);
600 throw exception(
"Call to set_status from invalid state", ec);
605template <
typename config>
607 lib::error_code & ec)
609 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
614 ec = m_response.set_body(value);
617#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
618template <
typename config>
619void connection<config>::set_body(std::string
const & value) {
621 this->set_body(value, ec);
623 throw exception(
"Call to set_body from invalid state", ec);
628#ifdef _WEBSOCKETPP_MOVE_SEMANTICS_
629template <
typename config>
630void connection<config>::set_body(std::string && value,
631 lib::error_code & ec)
633 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
638 ec = m_response.set_body(std::move(value));
641#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
642template <
typename config>
643void connection<config>::set_body(std::string && value) {
645 this->set_body(std::move(value), ec);
647 throw exception(
"Call to set_body from invalid state", ec);
653template <
typename config>
654void connection<config>::append_header(std::string
const & key,
655 std::string
const & val, lib::error_code & ec)
658 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
660 ec = m_response.append_header(key, val);
665 if (m_internal_state == istate::USER_INIT) {
667 ec = m_request.append_header(key, val);
674#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
675template <
typename config>
676void connection<config>::append_header(std::string
const & key,
677 std::string
const & val)
680 this->append_header(key, val, ec);
682 throw exception(
"Call to append_header from invalid state", ec);
687template <
typename config>
688void connection<config>::replace_header(std::string
const & key,
689 std::string
const & val, lib::error_code & ec)
692 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
694 ec = m_response.replace_header(key, val);
699 if (m_internal_state == istate::USER_INIT) {
701 ec = m_request.replace_header(key, val);
708#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
709template <
typename config>
710void connection<config>::replace_header(std::string
const & key,
711 std::string
const & val)
714 this->replace_header(key, val, ec);
716 throw exception(
"Call to replace_header from invalid state", ec);
721template <
typename config>
722void connection<config>::remove_header(std::string
const & key,
723 lib::error_code & ec)
726 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
728 ec = m_response.remove_header(key);
733 if (m_internal_state == istate::USER_INIT) {
735 ec = m_request.remove_header(key);
742#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
743template <
typename config>
744void connection<config>::remove_header(std::string
const & key)
747 this->remove_header(key, ec);
749 throw exception(
"Call to remove_header from invalid state", ec);
756
757
758
759
760
761
762
763
764
765template <
typename config>
769 if (m_handshake_timer) {
770 m_handshake_timer->cancel();
771 m_handshake_timer.reset();
775 m_http_state = session::http_state::deferred;
777 return lib::error_code();
782
783
784
785
786
787
788
789
790template <
typename config>
793 scoped_lock_type lock(m_connection_state_lock);
794 if (m_http_state != session::http_state::deferred) {
799 m_http_state = session::http_state::body_written;
802 this->write_http_response(lib::error_code());
803 ec = lib::error_code();
806#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
807template <
typename config>
810 this->send_http_response(ec);
822template <
typename config>
826 if (m_internal_state != istate::USER_INIT) {
832 m_internal_state = istate::TRANSPORT_INIT;
839 &
type::handle_transport_init,
841 lib::placeholders::_1
846template <
typename config>
847void connection<config>::handle_transport_init(lib::error_code
const & ec) {
850 lib::error_code ecm = ec;
852 if (m_internal_state != istate::TRANSPORT_INIT) {
854 "handle_transport_init must be called from transport init state");
860 s <<
"handle_transport_init received error: "<< ecm.message();
863 this->terminate(ecm);
869 m_internal_state = istate::READ_HTTP_REQUEST;
870 this->read_handshake(1);
874 m_internal_state = istate::WRITE_HTTP_REQUEST;
875 m_processor = get_processor(config::client_version);
876 this->send_http_request();
880template <
typename config>
881void connection<config>::read_handshake(size_t num_bytes) {
884 if (m_open_handshake_timeout_dur > 0) {
886 m_open_handshake_timeout_dur,
888 &
type::handle_open_handshake_timeout,
890 lib::placeholders::_1
898 config::connection_read_buffer_size,
900 &type::handle_read_handshake,
902 lib::placeholders::_1,
903 lib::placeholders::_2
910template <
typename config>
911void connection<config>::handle_read_handshake(lib::error_code
const & ec,
912 size_t bytes_transferred)
916 lib::error_code ecm = ec;
919 scoped_lock_type lock(m_connection_state_lock);
921 if (m_state == session::state::connecting) {
922 if (m_internal_state != istate::READ_HTTP_REQUEST) {
925 }
else if (m_state == session::state::closed) {
930 "handle_read_handshake invoked after connection was closed");
941 "got (expected) eof/state error from closed con");
946 this->terminate(ecm);
951 if (bytes_transferred > config::connection_read_buffer_size) {
957 size_t bytes_processed = 0;
958 lib::error_code consume_ec;
960 bytes_processed = m_request.consume(m_buf, bytes_transferred, consume_ec);
965 log_err(log
::elevel::fatal,
"Fatal error reading request: ",consume_ec);
972 if (bytes_processed > bytes_transferred) {
980 s <<
"bytes_transferred: " << bytes_transferred
981 <<
" bytes, bytes processed: " << bytes_processed <<
" bytes";
985 if (m_request.ready()) {
988 this->write_http_response_error(processor_ec);
992 if (m_processor && m_processor->get_version() == 0) {
995 if (bytes_transferred-bytes_processed >= 8) {
996 m_request.replace_header(
997 "Sec-WebSocket-Key3",
998 std::string(m_buf+bytes_processed,m_buf+bytes_processed+8)
1000 bytes_processed += 8;
1012 if (!m_request.get_header(
"Sec-WebSocket-Key3").empty()) {
1014 utility::to_hex(m_request.get_header(
"Sec-WebSocket-Key3")));
1021 std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
1022 m_buf_cursor = bytes_transferred-bytes_processed;
1025 m_internal_state = istate::PROCESS_HTTP_REQUEST;
1033 if (!m_is_http || m_http_state == session::http_state::init) {
1034 this->write_http_response(handshake_ec);
1040 if (bytes_transferred != bytes_processed) {
1041 m_elog->write(log
::elevel::fatal,
"Assertion Failed: HTTP request parser failed to consume all bytes from a read request.");
1050 config::connection_read_buffer_size,
1052 &type::handle_read_handshake,
1054 lib::placeholders::_1,
1055 lib::placeholders::_2
1066template <
typename config>
1067void connection<config>::write_http_response_error(lib::error_code
const & ec) {
1068 if (m_internal_state != istate::READ_HTTP_REQUEST) {
1070 "write_http_response_error called in invalid state");
1075 m_internal_state = istate::PROCESS_HTTP_REQUEST;
1077 this->write_http_response(ec);
1082template <
typename config>
1083void connection<config>::handle_read_frame(lib::error_code
const & ec,
1084 size_t bytes_transferred)
1088 lib::error_code ecm = ec;
1090 if (!ecm && m_internal_state != istate::PROCESS_CONNECTION) {
1098 if (m_state == session::state::closed) {
1103 }
else if (m_state == session::state::closing && !m_is_server) {
1107 terminate(lib::error_code());
1115 if (m_state == session::state::closed) {
1117 "handle_read_frame: got invalid istate in closed state");
1130 log_err(echannel,
"handle_read_frame", ecm);
1131 this->terminate(ecm);
1137
1138
1139
1140
1145 std::stringstream s;
1146 s <<
"p = " << p <<
" bytes transferred = " << bytes_transferred;
1150 while (p < bytes_transferred) {
1152 std::stringstream s;
1153 s <<
"calling consume with " << bytes_transferred-p <<
" bytes";
1157 lib::error_code consume_ec;
1160 std::stringstream s;
1161 s <<
"Processing Bytes: " <<
utility::to_hex(
reinterpret_cast<uint8_t*>(m_buf)+p,bytes_transferred-p);
1165 p += m_processor->consume(
1166 reinterpret_cast<uint8_t*>(m_buf)+p,
1167 bytes_transferred-p,
1172 std::stringstream s;
1173 s <<
"bytes left after consume: " << bytes_transferred-p;
1179 if (config::drop_on_protocol_error) {
1180 this->terminate(consume_ec);
1183 lib::error_code close_ec;
1186 consume_ec.message(),
1192 this->terminate(close_ec);
1199 if (m_processor->ready()) {
1201 std::stringstream s;
1202 s <<
"Complete message received. Dispatching";
1206 message_ptr msg = m_processor->get_message();
1210 }
else if (!is_control(msg->get_opcode())) {
1212 if (m_state != session::state::open) {
1213 m_elog->write(log
::elevel::warn,
"got non-close frame while closing");
1214 }
else if (m_message_handler) {
1215 m_message_handler(m_connection_hdl, msg);
1218 process_control_frame(msg);
1227template <
typename config>
1240
1243 config::connection_read_buffer_size,
1248template <
typename config>
1253 if (!
processor::is_websocket_handshake(m_request)) {
1254 return lib::error_code();
1257 int version =
processor::get_websocket_version(m_request);
1260 m_alog->write(log
::alevel::devel,
"BAD REQUEST: can't determine version");
1265 m_processor = get_processor(version);
1269 return lib::error_code();
1274 m_alog->write(log
::alevel::devel,
"BAD REQUEST: no processor for version");
1277 std::stringstream ss;
1279 std::vector<
int>::const_iterator it;
1280 for (it = versions_supported.begin(); it != versions_supported.end(); it++)
1286 m_response.replace_header(
"Sec-WebSocket-Version",ss.str());
1290template <
typename config>
1294 if (!
processor::is_websocket_handshake(m_request)) {
1299 m_uri = processor::get_uri_from_host(
1301 (transport_con_type::is_secure() ?
"https" :
"http")
1304 if (!m_uri->get_valid()) {
1305 m_alog->write(log
::alevel::devel,
"Bad request: failed to parse uri");
1310 if (m_http_handler) {
1312 m_http_handler(m_connection_hdl);
1314 if (m_state == session::state::closed) {
1322 return lib::error_code();
1325 lib::error_code ec = m_processor->validate_handshake(m_request);
1337 std::pair<lib::error_code,std::string> neg_results;
1338 neg_results = m_processor->negotiate_extensions(m_request);
1343 m_elog->write(log
::elevel::info,
"Bad request: " + neg_results.first.message());
1345 return neg_results.first;
1346 }
else if (neg_results.first) {
1351 "Extension negotiation failed: " + neg_results.first.message());
1356 if (neg_results.second.size() > 0) {
1357 m_response.replace_header(
"Sec-WebSocket-Extensions",
1358 neg_results.second);
1363 m_uri = m_processor->get_uri(m_request);
1366 if (!m_uri->get_valid()) {
1367 m_alog->write(log
::alevel::devel,
"Bad request: failed to parse uri");
1373 lib::error_code subp_ec = m_processor->extract_subprotocols(m_request,
1374 m_requested_subprotocols);
1381 if (!m_validate_handler || m_validate_handler(m_connection_hdl)) {
1386 ec = m_processor->process_handshake(m_request,m_subprotocol,m_response);
1389 std::stringstream s;
1390 s <<
"Processing error: " << ec <<
"(" << ec.message() <<
")";
1403 if (m_response.get_status_code() ==
http::
status_code::uninitialized) {
1410 return lib::error_code();
1413template <
typename config>
1414void connection<config>::write_http_response(lib::error_code
const & ec) {
1418 m_alog->write(log
::alevel::http,
"An HTTP handler took over the connection.");
1422 if (m_response.get_status_code() ==
http::
status_code::uninitialized) {
1423 lib::error_code status_ec;
1430 m_response.set_version(
"HTTP/1.1");
1433 if (m_response.get_header(
"Server").empty()) {
1434 if (!m_user_agent.empty()) {
1435 m_response.replace_header(
"Server",m_user_agent);
1437 m_response.remove_header(
"Server");
1443 m_handshake_buffer = m_processor->get_raw(m_response);
1446 m_handshake_buffer = m_response.raw();
1450 m_alog->write(log
::alevel::devel,
"Raw Handshake response:\n"+m_handshake_buffer);
1451 if (!m_response.get_header(
"Sec-WebSocket-Key3").empty()) {
1453 utility::to_hex(m_response.get_header(
"Sec-WebSocket-Key3")));
1459 m_handshake_buffer.data(),
1460 m_handshake_buffer.size(),
1462 &
type::handle_write_http_response,
1464 lib::placeholders::_1
1469template <
typename config>
1470void connection<config>::handle_write_http_response(lib::error_code
const & ec) {
1473 lib::error_code ecm = ec;
1476 scoped_lock_type lock(m_connection_state_lock);
1478 if (m_state == session::state::connecting) {
1479 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
1482 }
else if (m_state == session::state::closed) {
1487 "handle_write_http_response invoked after connection was closed");
1498 "got (expected) eof/state error from closed con");
1503 this->terminate(ecm);
1507 if (m_handshake_timer) {
1508 m_handshake_timer->cancel();
1509 m_handshake_timer.reset();
1512 if (m_response.get_status_code() !=
http::
status_code::switching_protocols)
1515
1516
1517
1519 std::stringstream s;
1520 s <<
"Handshake ended with HTTP error: "
1521 << m_response.get_status_code();
1527 this->log_http_result();
1531 "got to writing HTTP results with m_ec set: "+m_ec.message());
1536 this->terminate(m_ec);
1540 this->log_open_result();
1542 m_internal_state = istate::PROCESS_CONNECTION;
1543 m_state = session::state::open;
1545 if (m_open_handler) {
1546 m_open_handler(m_connection_hdl);
1549 this->handle_read_frame(lib::error_code(), m_buf_cursor);
1552template <
typename config>
1553void connection<config>::send_http_request() {
1562 ec = m_processor->client_handshake_request(m_request,m_uri,
1563 m_requested_subprotocols);
1570 m_elog->write(log
::elevel::fatal,
"Internal library error: missing processor");
1575 if (m_request.get_header(
"User-Agent").empty()) {
1576 if (!m_user_agent.empty()) {
1577 m_request.replace_header(
"User-Agent",m_user_agent);
1579 m_request.remove_header(
"User-Agent");
1583 m_handshake_buffer = m_request.raw();
1586 m_alog->write(log
::alevel::devel,
"Raw Handshake request:\n"+m_handshake_buffer);
1589 if (m_open_handshake_timeout_dur > 0) {
1591 m_open_handshake_timeout_dur,
1593 &
type::handle_open_handshake_timeout,
1595 lib::placeholders::_1
1601 m_handshake_buffer.data(),
1602 m_handshake_buffer.size(),
1604 &
type::handle_send_http_request,
1606 lib::placeholders::_1
1611template <
typename config>
1612void connection<config>::handle_send_http_request(lib::error_code
const & ec) {
1615 lib::error_code ecm = ec;
1618 scoped_lock_type lock(m_connection_state_lock);
1620 if (m_state == session::state::connecting) {
1621 if (m_internal_state != istate::WRITE_HTTP_REQUEST) {
1624 m_internal_state = istate::READ_HTTP_RESPONSE;
1626 }
else if (m_state == session::state::closed) {
1631 "handle_send_http_request invoked after connection was closed");
1642 "got (expected) eof/state error from closed con");
1647 this->terminate(ecm);
1654 config::connection_read_buffer_size,
1656 &type::handle_read_http_response,
1658 lib::placeholders::_1,
1659 lib::placeholders::_2
1664template <
typename config>
1665void connection<config>::handle_read_http_response(lib::error_code
const & ec,
1666 size_t bytes_transferred)
1670 lib::error_code ecm = ec;
1673 scoped_lock_type lock(m_connection_state_lock);
1675 if (m_state == session::state::connecting) {
1676 if (m_internal_state != istate::READ_HTTP_RESPONSE) {
1679 }
else if (m_state == session::state::closed) {
1684 "handle_read_http_response invoked after connection was closed");
1695 "got (expected) eof/state error from closed con");
1700 this->terminate(ecm);
1704 size_t bytes_processed = 0;
1706 lib::error_code consume_ec;
1708 bytes_processed = m_response.consume(m_buf, bytes_transferred, consume_ec);
1713 log_err(log
::elevel::rerror,
"error in handle_read_http_response: ",consume_ec);
1718 m_alog->write(log
::alevel::devel,std::string(
"Raw response: ")+m_response.raw());
1720 if (m_response.headers_ready()) {
1721 if (m_handshake_timer) {
1722 m_handshake_timer->cancel();
1723 m_handshake_timer.reset();
1726 lib::error_code validate_ec = m_processor->validate_server_handshake_response(
1732 this->terminate(validate_ec);
1738 std::pair<lib::error_code,std::string> neg_results;
1739 neg_results = m_processor->negotiate_extensions(m_response);
1741 if (neg_results.first) {
1750 + neg_results.first.message());
1756 m_internal_state = istate::PROCESS_CONNECTION;
1757 m_state = session::state::open;
1759 this->log_open_result();
1761 if (m_open_handler) {
1762 m_open_handler(m_connection_hdl);
1768 std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
1769 m_buf_cursor = bytes_transferred-bytes_processed;
1771 this->handle_read_frame(lib::error_code(), m_buf_cursor);
1776 if (bytes_transferred != bytes_processed) {
1777 m_elog->write(log
::elevel::fatal,
"Assertion Failed: HTTP response parser failed to consume all bytes from a read request.");
1785 config::connection_read_buffer_size,
1787 &type::handle_read_http_response,
1789 lib::placeholders::_1,
1790 lib::placeholders::_2
1796template <
typename config>
1797void connection<config>::handle_open_handshake_timeout(
1798 lib::error_code
const & ec)
1804 "open handle_open_handshake_timeout error: "+ec.message());
1812template <
typename config>
1813void connection<config>::handle_close_handshake_timeout(
1814 lib::error_code
const & ec)
1817 m_alog->write(log
::alevel::devel,
"asio close handshake timer cancelled");
1820 "asio open handle_close_handshake_timeout error: "+ec.message());
1823 m_alog->write(log
::alevel::devel,
"asio close handshake timer expired");
1828template <
typename config>
1829void connection<config>::terminate(lib::error_code
const & ec) {
1835 if (m_handshake_timer) {
1836 m_handshake_timer->cancel();
1837 m_handshake_timer.reset();
1842 m_ping_timer->cancel();
1843 m_handshake_timer.reset();
1846 terminate_status tstat = unknown;
1850 m_local_close_reason = ec.message();
1855 m_http_state = session::http_state::closed;
1857 if (m_state == session::state::connecting) {
1858 m_state = session::state::closed;
1866 }
else if (m_state != session::state::closed) {
1867 m_state = session::state::closed;
1871 "terminate called on connection that was already terminated");
1879 &
type::handle_terminate,
1882 lib::placeholders::_1
1887template <
typename config>
1888void connection<config>::handle_terminate(terminate_status tstat,
1889 lib::error_code
const & ec)
1901 if (tstat == failed) {
1903 if (m_fail_handler) {
1904 m_fail_handler(m_connection_hdl);
1907 }
else if (tstat == closed) {
1908 if (m_close_handler) {
1909 m_close_handler(m_connection_hdl);
1920 if (m_termination_handler) {
1921#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
1924 }
catch (std::exception
const & e) {
1926 std::string(
"termination_handler call failed. Reason was: ")+e.what());
1929 m_termination_handler(type::get_shared());
1934template <
typename config>
1939 scoped_lock_type lock(m_write_lock);
1951 message_ptr next_message = write_pop();
1952 while (next_message) {
1953 m_current_msgs.push_back(next_message);
1954 if (!next_message->get_terminal()) {
1955 next_message = write_pop();
1957 next_message = message_ptr();
1961 if (m_current_msgs.empty()) {
1968 m_write_flag =
true;
1972 typename std::vector<message_ptr>::iterator it;
1973 for (it = m_current_msgs.begin(); it != m_current_msgs.end(); ++it) {
1974 std::string
const & header = (*it)->get_header();
1975 std::string
const & payload = (*it)->get_payload();
1977 m_send_buffer.push_back(transport::buffer(header.c_str(),header.size()));
1978 m_send_buffer.push_back(transport::buffer(payload.c_str(),payload.size()));
1984 std::stringstream general,header,payload;
1986 general <<
"Dispatching write containing " << m_current_msgs.size()
1987 <<
" message(s) containing ";
1988 header <<
"Header Bytes: \n";
1989 payload <<
"Payload Bytes: \n";
1994 for (size_t i = 0; i < m_current_msgs.size(); i++) {
1995 hbytes += m_current_msgs[i]->get_header().size();
1996 pbytes += m_current_msgs[i]->get_payload().size();
1999 header <<
"[" << i <<
"] ("
2000 << m_current_msgs[i]->get_header().size() <<
") "
2001 << utility::to_hex(m_current_msgs[i]->get_header()) <<
"\n";
2005 payload <<
"[" << i <<
"] ("
2006 << m_current_msgs[i]->get_payload().size() <<
") ["<<m_current_msgs[i]->get_opcode()<<
"] "
2007 << (m_current_msgs[i]->get_opcode() == frame::opcode::text ?
2008 m_current_msgs[i]->get_payload() :
2009 utility::to_hex(m_current_msgs[i]->get_payload())
2016 general << hbytes <<
" header bytes and " << pbytes <<
" payload bytes";
2026 m_write_frame_handler
2030template <
typename config>
2037 bool terminal = m_current_msgs.back()->get_terminal();
2039 m_send_buffer.clear();
2040 m_current_msgs.clear();
2045 this->terminate(ec);
2050 this->terminate(lib::error_code());
2054 bool needs_writing =
false;
2056 scoped_lock_type lock(m_write_lock);
2059 m_write_flag =
false;
2061 needs_writing = !m_send_queue.empty();
2064 if (needs_writing) {
2072template <
typename config>
2075 return versions_supported;
2078template <
typename config>
2079void connection<config>::process_control_frame(
typename config::message_type::ptr msg)
2086 std::stringstream s;
2087 s <<
"Control frame received with opcode " << op;
2090 if (m_state == session::state::closed) {
2094 if (op !=
frame::
opcode::CLOSE && m_state != session::state::open) {
2095 m_elog->write(log
::elevel::warn,
"got non-close frame in state closing");
2100 bool should_reply =
true;
2102 if (m_ping_handler) {
2103 should_reply = m_ping_handler(m_connection_hdl, msg->get_payload());
2107 this->pong(msg->get_payload(),ec);
2114 m_ping_timer->cancel();
2116 if (m_pong_handler) {
2117 m_pong_handler(m_connection_hdl, msg->get_payload());
2123 m_remote_close_code =
close::extract_code(msg->get_payload(),ec);
2126 if (config::drop_on_protocol_error) {
2127 s <<
"Received invalid close code " << m_remote_close_code
2128 <<
" dropping connection per config.";
2130 this->terminate(ec);
2132 s <<
"Received invalid close code " << m_remote_close_code
2133 <<
" sending acknowledgement and closing";
2136 "Invalid close code");
2144 m_remote_close_reason =
close::extract_reason(msg->get_payload(),ec);
2146 if (config::drop_on_protocol_error) {
2148 "Received invalid close reason. Dropping connection per config");
2149 this->terminate(ec);
2152 "Received invalid close reason. Sending acknowledgement and closing");
2154 "Invalid close reason");
2162 if (m_state == session::state::open) {
2164 s <<
"Received close frame with code " << m_remote_close_code
2165 <<
" and reason " << m_remote_close_reason;
2168 ec = send_close_ack();
2172 }
else if (m_state == session::state::closing && !m_was_clean) {
2186 terminate(lib::error_code());
2194 m_elog->write(log
::elevel::devel,
"Got control frame with invalid opcode");
2199template <
typename config>
2201 std::string
const & reason)
2203 return send_close_frame(code,reason,
true,m_is_server);
2206template <
typename config>
2208 std::string
const & reason,
bool ack,
bool terminal)
2220 if (config::silent_close) {
2223 m_local_close_reason.clear();
2226 m_local_close_code = code;
2227 m_local_close_reason = reason;
2231 m_local_close_reason.clear();
2234 "acknowledging a no-status close with normal code");
2236 m_local_close_reason.clear();
2239 m_local_close_code = m_remote_close_code;
2240 m_local_close_reason = m_remote_close_reason;
2243 std::stringstream s;
2244 s <<
"Closing with code: " << m_local_close_code <<
", and reason: "
2245 << m_local_close_reason;
2248 message_ptr msg = m_msg_manager->get_message();
2253 lib::error_code ec = m_processor->prepare_close(m_local_close_code,
2254 m_local_close_reason,msg);
2263 msg->set_terminal(
true);
2266 m_state = session::state::closing;
2272 m_ping_timer->cancel();
2281 if (m_close_handshake_timeout_dur > 0) {
2283 m_close_handshake_timeout_dur,
2285 &
type::handle_close_handshake_timeout,
2287 lib::placeholders::_1
2292 bool needs_writing =
false;
2294 scoped_lock_type lock(m_write_lock);
2296 needs_writing = !m_write_flag && !m_send_queue.empty();
2299 if (needs_writing) {
2306 return lib::error_code();
2309template <
typename config>
2311connection<config>::get_processor(
int version)
const {
2353 p->set_max_message_size(m_max_message_size);
2358template <
typename config>
2359void connection<config>::write_push(
typename config::message_type::ptr msg)
2365 m_send_buffer_size += msg->get_payload().size();
2366 m_send_queue.push(msg);
2369 std::stringstream s;
2370 s <<
"write_push: message count: " << m_send_queue.size()
2371 <<
" buffer size: " << m_send_buffer_size;
2376template <
typename config>
2377typename config::message_type::ptr
connection<config>::write_pop()
2381 if (m_send_queue.empty()) {
2385 msg = m_send_queue.front();
2387 m_send_buffer_size -= msg->get_payload().size();
2391 std::stringstream s;
2392 s <<
"write_pop: message count: " << m_send_queue.size()
2393 <<
" buffer size: " << m_send_buffer_size;
2399template <
typename config>
2402 std::stringstream s;
2405 if (!
processor::is_websocket_handshake(m_request)) {
2408 version =
processor::get_websocket_version(m_request);
2412 s << (version == -1 ?
"HTTP" :
"WebSocket") <<
" Connection ";
2418 if (version != -1) {
2419 s <<
"v" << version <<
" ";
2423 std::string ua = m_request.get_header(
"User-Agent");
2428 s <<
"\"" <<
utility::string_replace_all(ua,
"\"",
"\\\"") <<
"\" ";
2432 s << (m_uri ? m_uri->get_resource() :
"NULL") <<
" ";
2435 s << m_response.get_status_code();
2440template <
typename config>
2443 std::stringstream s;
2446 <<
"close local:[" << m_local_close_code
2447 << (m_local_close_reason.empty() ?
"" :
","+m_local_close_reason)
2448 <<
"] remote:[" << m_remote_close_code
2449 << (m_remote_close_reason.empty() ?
"" :
","+m_remote_close_reason) <<
"]";
2454template <
typename config>
2457 std::stringstream s;
2459 int version =
processor::get_websocket_version(m_request);
2462 s <<
"WebSocket Connection ";
2469 s <<
" v" << version;
2473 std::string ua = m_request.get_header(
"User-Agent");
2478 s <<
" \"" <<
utility::string_replace_all(ua,
"\"",
"\\\"") <<
"\" ";
2482 s << (m_uri ? m_uri->get_resource() :
"-");
2485 s <<
" " << m_response.get_status_code();
2488 s <<
" " << m_ec <<
" " << m_ec.message();
2493template <
typename config>
2495 std::stringstream s;
2497 if (
processor::is_websocket_handshake(m_request)) {
2498 m_alog->write(log
::alevel::devel,
"Call to log_http_result for WebSocket");
2503 s << (m_request.get_header(
"host").empty() ?
"-" : m_request.get_header(
"host"))
2504 <<
" " << transport_con_type::get_remote_endpoint()
2505 <<
" \"" << m_request.get_method()
2506 <<
" " << (m_uri ? m_uri->get_resource() :
"-")
2507 <<
" " << m_request.get_version() <<
"\" " << m_response.get_status_code()
2508 <<
" " << m_response.get_body().size();
2511 std::string ua = m_request.get_header(
"User-Agent");
2516 s <<
" \"" <<
utility::string_replace_all(ua,
"\"",
"\\\"") <<
"\" ";
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_MEMORY_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
#define _WEBSOCKETPP_INITIALIZER_LISTS_
Concurrency policy that uses std::mutex / boost::mutex.
Stub for user supplied base class.
Represents an individual WebSocket connection.
ptr get_shared()
Get a shared pointer to this component.
void handle_interrupt()
Transport interrupt callback.
void set_message_handler(message_handler h)
Set message handler.
lib::error_code interrupt()
Asynchronously invoke handler::on_interrupt.
void start()
Start the connection state machine.
std::string const & get_request_body() const
Retrieve a request body.
config::transport_type::transport_con_type transport_con_type
Type of the transport component of this connection.
void set_close_handler(close_handler h)
Set close handler.
lib::error_code send(message_ptr msg)
Add a message to the outgoing send queue.
config::alog_type alog_type
Type of the access logging policy.
http::status_code::value get_response_code() const
Get response HTTP status code.
lib::error_code defer_http_response()
Defer HTTP Response until later (Exception free).
lib::error_code resume_reading()
Resume reading of new data.
bool get_secure() const
Returns the secure flag from the connection URI.
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
size_t get_buffered_amount() const
Get the size of the outgoing write buffer (in payload bytes).
std::string const & get_origin() const
Return the same origin policy origin value from the opening request.
std::string const & get_host() const
Returns the host component of the connection URI.
response_type const & get_response() const
Get response object.
void set_max_message_size(size_t new_value)
Set maximum message size.
std::string const & get_resource() const
Returns the resource component of the connection URI.
lib::error_code process_handshake_request()
void handle_pause_reading()
Pause reading callback.
std::vector< int > const & get_supported_versions() const
Get array of WebSocket protocol versions that this connection supports.
lib::error_code send(void const *payload, size_t len, frame::opcode::value op=frame::opcode::binary)
Send a message (raw array overload).
uri_ptr get_uri() const
Gets the connection URI.
connection_hdl get_handle() const
Get Connection Handle.
void send_http_response(lib::error_code &ec)
Send deferred HTTP Response (exception free).
connection< config > type
Type of this connection.
void set_http_handler(http_handler h)
Set http handler.
std::string const & get_response_msg() const
Get response HTTP status message.
config::elog_type elog_type
Type of the error logging policy.
message_ptr get_message(websocketpp::frame::opcode::value op, size_t size) const
Get a message buffer.
void handle_write_frame(lib::error_code const &ec)
Process the results of a frame write operation and start the next write.
close::status::value get_local_close_code() const
Get the WebSocket close code sent by this endpoint.
lib::error_code get_ec() const
Get the internal error code for a closed/failed connection.
void set_status(http::status_code::value code, lib::error_code &ec)
Set response status code and message (exception free).
void set_fail_handler(fail_handler h)
Set fail handler.
void write_frame()
Checks if there are frames in the send queue and if there are sends one.
session::state::value get_state() const
Return the connection state.
void set_status(http::status_code::value code)
Set response status code and message (exception).
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
config::concurrency_type concurrency_type
Type of the concurrency component of this connection.
transport_con_type::timer_ptr timer_ptr
Type of a pointer to a transport timer handle.
void set_validate_handler(validate_handler h)
Set validate handler.
void set_interrupt_handler(interrupt_handler h)
Set interrupt handler.
size_t buffered_amount() const
Get the size of the outgoing write buffer (in payload bytes).
void send_http_response()
Send deferred HTTP Response.
close::status::value get_remote_close_code() const
Get the WebSocket close code sent by the remote endpoint.
void set_open_handler(open_handler h)
Set open handler.
bool is_server() const
Get whether or not this connection is part of a server or client.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection.
std::string const & get_remote_close_reason() const
Get the WebSocket close reason sent by the remote endpoint.
void set_pong_timeout(long dur)
Set pong timeout.
lib::error_code initialize_processor()
void set_uri(uri_ptr uri)
Sets the connection URI.
void set_termination_handler(termination_handler new_handler)
request_type const & get_request() const
Get request object.
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
transport_con_type::ptr transport_con_ptr
Type of a shared pointer to the transport component of this connection.
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
lib::error_code pause_reading()
Pause reading of new data.
void handle_resume_reading()
Resume reading callback.
std::vector< std::string > const & get_requested_subprotocols() const
Gets all of the subprotocols requested by the client.
std::string const & get_subprotocol() const
Gets the negotiated subprotocol.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void read_frame()
Issue a new transport read unless reading is paused.
uint16_t get_port() const
Returns the port component of the connection URI.
std::string const & get_local_close_reason() const
Get the WebSocket close reason sent by this endpoint.
size_t get_max_message_size() const
Get maximum message size.
config::rng_type rng_type
Type of RNG.
Stub for user supplied base class.
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.
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.
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.
void resume_reading(connection_hdl hdl)
Resume reading of new data.
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 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 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).
void send_http_response(connection_hdl hdl)
Send deferred HTTP Response (exception free).
void pause_reading(connection_hdl hdl)
Pause reading of new data.
connection_type::message_handler message_handler
Type of message_handler.
connection_type::weak_ptr connection_weak_ptr
Weak pointer to connection type.
Stub class for use when disabling permessage_deflate extension.
bool is_implemented() const
err_str_pair negotiate(http::attribute_list const &)
Negotiate extension.
std::string generate_offer() const
Generate extension offer.
void set_max_message_size(size_t)
Set maximum decompressed message size (no-op).
lib::error_code init(bool)
Initialize state.
HTTP parser error category.
An exception type specific to HTTP errors.
header_list const & get_headers() const
Return a list of all HTTP headers.
std::string const & get_body() const
Get HTTP body.
bool body_ready() const
Check if the parser is done parsing the body.
void set_max_body_size(size_t value)
Set body size limit.
bool prepare_body(lib::error_code &ec)
Prepare the parser to begin parsing body data.
std::string raw_headers() const
Generate and return the HTTP headers as a string.
size_t process_body(char const *buf, size_t len, lib::error_code &ec)
Process body data.
std::string const & get_version() const
Get the HTTP version string.
size_t get_max_body_size() const
Get body size limit.
lib::error_code process_header(std::string::iterator begin, std::string::iterator end)
Process a header line.
Stores, parses, and manipulates HTTP requests.
std::string raw() const
Returns the full raw request (including the body).
std::string const & get_uri() const
Return the requested URI.
std::string const & get_method() const
Return the request method.
bool ready() const
Returns whether or not the request is ready for reading.
size_t consume(char const *buf, size_t len, lib::error_code &ec)
Process bytes in the input buffer.
std::string raw_head() const
Returns the raw request headers only (similar to an HTTP HEAD request).
Stores, parses, and manipulates HTTP responses.
std::string raw() const
Returns the full raw response.
size_t consume(char const *buf, size_t len, lib::error_code &ec)
Process bytes in the input buffer.
bool headers_ready() const
Returns true if the response headers are fully parsed.
size_t consume(std::istream &s, lib::error_code &ec)
Process bytes in the input buffer (istream version).
lib::error_code set_status(status_code::value code)
Set response status code and message.
bool ready() const
Returns true if the response is ready.
const std::string & get_status_msg() const
Return the response status message.
status_code::value get_status_code() const
Return the response status code.
Basic logger that outputs to an ostream.
void write(level channel, char const *msg)
Write a cstring message to the given channel.
basic(basic< concurrency, names > const &other)
Copy constructor.
bool recycle(message *)
Recycle a message.
message_ptr get_message(frame::opcode::value op, size_t size)
Get a message buffer with specified size and opcode.
message_ptr get_message()
Get an empty message buffer.
con_msg_man_ptr get_manager() const
Get a pointer to a connection message manager.
Represents a buffer for a single WebSocket message.
message(const con_msg_man_ptr manager, frame::opcode::value op, size_t size=128)
Construct a message and fill in some values.
std::string & get_raw_payload()
Get a non-const reference to the payload string.
bool recycle()
Recycle the message.
bool get_compressed() const
Return whether or not the message is flagged as compressed.
bool get_terminal() const
Get whether or not the message is terminal.
std::string const & get_header() const
Return the prepared frame header.
void set_payload(void const *payload, size_t len)
Set payload data.
bool get_fin() const
Read the fin bit.
void append_payload(void const *payload, size_t len)
Append payload data.
void set_opcode(frame::opcode::value op)
Set the opcode.
void set_prepared(bool value)
Set or clear the flag that indicates that the message has been prepared.
frame::opcode::value get_opcode() const
Return the message opcode.
void set_terminal(bool value)
Set the terminal flag.
bool get_prepared() const
Return whether or not the message has been prepared for sending.
void set_compressed(bool value)
Set or clear the compression flag.
message(const con_msg_man_ptr manager)
Construct an empty message.
void set_fin(bool value)
Set the fin bit.
std::string const & get_payload() const
Get a reference to the payload string.
Category for processor errors.
Processor for Hybi Draft version 00.
Processor for Hybi Draft version 07.
Processor for Hybi Draft version 08.
Processor for Hybi version 13 (RFC6455).
WebSocket protocol processor abstract base class.
virtual lib::error_code prepare_data_frame(message_ptr in, message_ptr out)=0
Prepare a data message for writing.
virtual size_t get_bytes_needed() const
virtual size_t consume(uint8_t *buf, size_t len, lib::error_code &ec)=0
process new websocket connection bytes
virtual err_str_pair negotiate_extensions(response_type const &)
Initializes extensions based on the Sec-WebSocket-Extensions header.
virtual void handle_max_message_size_changed(size_t)
Hook invoked when the maximum message size changes.
virtual int get_version() const =0
Get the protocol version of this processor.
virtual std::string get_raw(response_type const &request) const =0
Given a completed response, get the raw bytes to put on the wire.
virtual bool ready() const =0
Checks if there is a message ready.
virtual lib::error_code validate_handshake(request_type const &request) const =0
validate a WebSocket handshake request for this version
virtual uri_ptr get_uri(request_type const &request) const =0
Extracts client uri from a handshake request.
virtual err_str_pair negotiate_extensions(request_type const &)
Initializes extensions based on the Sec-WebSocket-Extensions header.
virtual bool has_permessage_compress() const
Returns whether or not the permessage_compress extension is implemented.
virtual lib::error_code validate_server_handshake_response(request_type const &req, response_type &res) const =0
Validate the server's response to an outgoing handshake request.
virtual lib::error_code client_handshake_request(request_type &req, uri_ptr uri, std::vector< std::string > const &subprotocols) const =0
Fill in an HTTP request for an outgoing connection handshake.
virtual lib::error_code extract_subprotocols(const request_type &req, std::vector< std::string > &subprotocol_list)=0
Extracts requested subprotocols from a handshake request.
virtual bool get_error() const =0
Tests whether the processor is in a fatal error state.
void set_max_message_size(size_t new_value)
Set maximum message size.
virtual std::string const & get_origin(request_type const &request) const =0
Return the value of the header containing the CORS origin.
size_t get_max_message_size() const
Get maximum message size.
virtual message_ptr get_message()=0
Retrieves the most recently processed message.
Thread safe stub "random" integer generator.
int_type operator()()
advances the engine's state and returns the generated value
Server endpoint role based on the given config.
transport_type::transport_con_type transport_con_type
Type of the connection transport component.
connection_type::ptr connection_ptr
Type of a shared pointer to the connections this server will create.
server< config > type
Type of this endpoint.
void start_accept(accept_loop_handler completion_handler)
Starts the server's async connection acceptance loop (exception free).
endpoint< connection_type, config > endpoint_type
Type of the endpoint component of this server.
config::transport_type transport_type
Type of the endpoint transport component.
connection< config > connection_type
Type of the connections this server will create.
connection_ptr get_connection(lib::error_code &ec)
Create and initialize a new connection.
connection_ptr get_connection()
Create and initialize a new connection.
lib::function< void(lib::error_code const &, lib::error_code const &)> accept_loop_handler
The type and signature of the callback passed to the start_accept method.
config::concurrency_type concurrency_type
Type of the endpoint concurrency component.
transport_con_type::ptr transport_con_ptr
Type of a shared pointer to the connection transport component.
Basic Asio connection socket component.
io_context_ptr io_service_ptr
Type of a pointer to the Asio io_context being used (deprecated).
lib::asio::ip::tcp::socket & get_raw_socket()
Retrieve a pointer to the underlying socket.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection socket component.
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
void set_uri(uri_ptr)
Set uri hook.
connection type
Type of this connection socket component.
lib::shared_ptr< lib::asio::io_context::strand > strand_ptr
Type of a pointer to the Asio io_context strand being used.
lib::asio::ip::tcp::socket & get_socket()
Retrieve a pointer to the underlying socket.
bool is_secure() const
Check whether or not this connection is secure.
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the socket being used.
static lib::error_code translate_ec(lib::error_code ec)
static lib::error_code translate_ec(ErrorCodeType)
Translate any security policy specific information about an error code.
void set_handle(connection_hdl hdl)
Sets the connection handle.
lib::asio::error_code cancel_socket()
Cancel all async operations on this socket.
void pre_init(init_handler callback)
Pre-initialize security policy.
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
lib::asio::io_context * io_context_ptr
Type of a pointer to the Asio io_context being used.
void post_init(init_handler callback)
Post-initialize security policy.
lib::asio::ip::tcp::socket socket_type
Type of the ASIO socket being used.
lib::error_code init_asio(io_context_ptr context, strand_ptr, bool)
Perform one time initializations.
ptr get_shared()
Get a shared pointer to this component.
lib::asio::ip::tcp::socket & get_next_layer()
Retrieve a pointer to the underlying socket.
Basic ASIO endpoint socket component.
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
endpoint type
The type of this endpoint socket component.
bool is_secure() const
Checks whether the endpoint creates secure connections.
connection socket_con_type
The type of the corresponding connection socket component.
socket_con_type::ptr socket_con_ptr
Asio based connection transport component.
void set_proxy_timeout(long duration)
Set the proxy timeout duration (exception).
void set_tcp_post_init_handler(tcp_init_handler h)
Sets the tcp post init handler.
void set_proxy_timeout(long duration, lib::error_code &ec)
Set the proxy timeout duration (exception free).
config::elog_type elog_type
Type of this transport's error logging policy.
strand_ptr get_strand()
Get a pointer to this connection's strand.
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
read at least num_bytes bytes into buf and then call handler.
socket_con_type::ptr socket_con_ptr
Type of a shared pointer to the socket connection component.
lib::error_code interrupt(interrupt_handler handler)
Trigger the on_interrupt handler.
lib::shared_ptr< lib::asio::io_context::strand > strand_ptr
Type of a pointer to the Asio io_context::strand being used.
config::alog_type alog_type
Type of this transport's access logging policy.
io_context_ptr io_service_ptr
Type of a pointer to the Asio io_context being used (deprecated).
lib::asio::io_context * io_context_ptr
Type of a pointer to the Asio io_context being used.
void handle_async_write(write_handler handler, lib::asio::error_code const &ec, size_t)
Async write callback.
void handle_timer(timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
Timer callback.
void handle_post_init(timer_ptr post_timer, init_handler callback, lib::error_code const &ec)
Post init timeout callback.
lib::error_code init_asio(io_context_ptr io_context)
Finish constructing the transport.
void async_shutdown(shutdown_handler callback)
close and clean up the underlying socket
lib::asio::error_code get_transport_ec() const
Get the internal transport error code for a closed/failed connection.
config::socket_type::socket_con_type socket_con_type
Type of the socket connection component.
void handle_post_init_timeout(timer_ptr, init_handler callback, lib::error_code const &ec)
Post init timeout callback.
connection< config > type
Type of this connection transport component.
void handle_async_shutdown_timeout(timer_ptr, init_handler callback, lib::error_code const &ec)
Async shutdown timeout handler.
lib::shared_ptr< lib::asio::steady_timer > timer_ptr
Type of a pointer to the Asio timer class.
void async_write(const char *buf, size_t len, write_handler handler)
Initiate a potentially asyncronous write of the given buffer.
void async_write(std::vector< buffer > const &bufs, write_handler handler)
Initiate a potentially asyncronous write of the given buffers.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
timer_ptr set_timer(long duration, timer_handler callback)
Call back a function after a period of time.
void set_tcp_init_handler(tcp_init_handler h)
Sets the tcp pre init handler (deprecated).
void handle_proxy_read(init_handler callback, lib::asio::error_code const &ec, size_t)
Proxy read callback.
void set_uri(uri_ptr u)
Set uri hook.
std::string get_remote_endpoint() const
Get the remote endpoint address.
ptr get_shared()
Get a shared pointer to this component.
void cancel_socket_checked()
Cancel the underlying socket and log any errors.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void set_tcp_pre_init_handler(tcp_init_handler h)
Sets the tcp pre init handler.
void init(init_handler callback)
Initialize transport for reading.
connection_hdl get_handle() const
Get the connection handle.
Asio based endpoint transport component.
lib::shared_ptr< lib::asio::executor_work_guard< lib::asio::io_context::executor_type > > work_guard_ptr
Type of a shared pointer to an io_context work object.
std::size_t run_one()
wraps the run_one method of the internal io_context object
socket_type::socket_con_type socket_con_type
Type of the socket connection component.
void stop_listening(lib::error_code &ec)
Stop listening (exception free).
config::socket_type socket_type
Type of the socket policy.
lib::shared_ptr< lib::asio::steady_timer > timer_ptr
Type of timer handle.
void async_connect(transport_con_ptr tcon, uri_ptr u, connect_handler cb)
Initiate a new connection.
void init_asio()
Initialize asio transport with internal io_context.
config::elog_type elog_type
Type of the error logging policy.
void init_logging(const lib::shared_ptr< alog_type > &a, const lib::shared_ptr< elog_type > &e)
Initialize logging.
lib::asio::io_context * io_context_ptr
Type of a pointer to the ASIO io_context being used.
bool is_secure() const
Return whether or not the endpoint produces secure connections.
lib::asio::ip::tcp::endpoint get_local_endpoint(lib::asio::error_code &ec)
Get local TCP endpoint.
void set_reuse_addr(bool value)
Sets whether to use the SO_REUSEADDR flag when opening listening sockets.
void set_tcp_init_handler(tcp_init_handler h)
Sets the tcp pre init handler (deprecated).
void handle_timer(timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
Timer handler.
lib::asio::io_context & get_io_service()
Retrieve a reference to the endpoint's io_context (deprecated).
void start_perpetual()
Marks the endpoint as perpetual, stopping it from exiting when empty.
void stop()
wraps the stop method of the internal io_context object
std::size_t run()
wraps the run method of the internal io_context object
void set_tcp_post_init_handler(tcp_init_handler h)
Sets the tcp post init handler.
void set_listen_backlog(int backlog)
Sets the maximum length of the queue of pending connections.
bool stopped() const
wraps the stopped method of the internal io_context object
timer_ptr set_timer(long duration, timer_handler callback)
Call back a function after a period of time.
socket_con_type::ptr socket_con_ptr
Type of a shared pointer to the socket connection component.
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
asio::connection< config > transport_con_type
void init_asio(lib::error_code &ec)
Initialize asio transport with internal io_context (exception free).
void async_accept(transport_con_ptr tcon, accept_handler callback)
Accept the next connection attempt and assign it to con.
void listen(uint16_t port)
Set up endpoint for listening on a port.
endpoint< config > type
Type of this endpoint transport component.
void init_asio(io_context_ptr ptr, lib::error_code &ec)
initialize asio transport with external io_context (exception free)
config::concurrency_type concurrency_type
Type of the concurrency policy.
std::size_t poll()
wraps the poll method of the internal io_context object
void stop_perpetual()
Clears the endpoint's perpetual flag, allowing it to exit when empty.
void init_asio(io_context_ptr ptr)
initialize asio transport with external io_context
lib::shared_ptr< lib::asio::ip::tcp::acceptor > acceptor_ptr
Type of a shared pointer to the acceptor being used.
void listen(lib::asio::ip::tcp::endpoint const &ep)
Set up endpoint for listening manually.
lib::asio::io_context & get_io_context()
Retrieve a reference to the endpoint's io_context.
void handle_resolve_timeout(timer_ptr, connect_handler callback, lib::error_code const &ec)
DNS resolution timeout handler.
void listen(lib::asio::ip::tcp::endpoint const &ep, lib::error_code &ec)
Set up endpoint for listening manually (exception free).
transport_con_type::ptr transport_con_ptr
void reset()
wraps the restart method of the internal io_context object
void set_tcp_pre_bind_handler(tcp_pre_bind_handler h)
Sets the tcp pre bind handler.
work_guard_ptr work_ptr
Type of a shared pointer to an io_context work object (deprecated).
config::alog_type alog_type
Type of the access logging policy.
void listen(InternetProtocol const &internet_protocol, uint16_t port)
Set up endpoint for listening with protocol and port.
void set_tcp_pre_init_handler(tcp_init_handler h)
Sets the tcp pre init handler.
void handle_connect_timeout(transport_con_ptr tcon, timer_ptr, connect_handler callback, lib::error_code const &ec)
Asio connect timeout handler.
void async_accept(transport_con_ptr tcon, accept_handler callback, lib::error_code &ec)
Accept the next connection attempt and assign it to con (exception free).
std::size_t poll_one()
wraps the poll_one method of the internal io_context object
void listen(InternetProtocol const &internet_protocol, uint16_t port, lib::error_code &ec)
Set up endpoint for listening with protocol and port (exception free).
void listen(uint16_t port, lib::error_code &ec)
Set up endpoint for listening on a port (exception free).
bool is_listening() const
Check if the endpoint is listening.
void stop_listening()
Stop listening.
io_context_ptr io_service_ptr
Type of a pointer to the ASIO io_context being used (deprecated).
lib::shared_ptr< lib::asio::ip::tcp::resolver > resolver_ptr
Type of a shared pointer to the resolver being used.
lib::function< lib::error_code(acceptor_ptr)> tcp_pre_bind_handler
Type of socket pre-bind handler.
Asio transport error category.
Error category related to asio transport socket policies.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
connection_hdl get_handle() const
Get the connection handle.
config::alog_type alog_type
Type of this transport's access logging policy.
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present).
void set_uri(uri_ptr)
Set uri hook.
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
void set_write_handler(write_handler h)
Sets the write handler.
void set_secure(bool value)
Set whether or not this connection is secure.
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
connection< config > type
Type of this connection transport component.
config::elog_type elog_type
Type of this transport's error logging policy.
void fatal_error()
Signal transport error.
size_t read_some(char const *buf, size_t len)
Manual input supply (read some).
size_t read_all(char const *buf, size_t len)
Manual input supply (read all).
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED).
config::concurrency_type concurrency_type
transport concurrency policy
void init(init_handler handler)
Initialize the connection transport.
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
bool is_secure() const
Tests whether or not the underlying transport is secure.
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
Initiate an async_read for at least num_bytes bytes into buf.
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather).
ptr get_shared()
Get a shared pointer to this component.
iostream::connection< config > transport_con_type
config::elog_type elog_type
Type of this endpoint's error logging policy.
void set_write_handler(write_handler h)
Sets the write handler.
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
bool is_secure() const
Tests whether or not the underlying transport is secure.
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
transport_con_type::ptr transport_con_ptr
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
endpoint type
Type of this endpoint transport component.
void register_ostream(std::ostream *o)
Register a default output stream.
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
config::alog_type alog_type
Type of this endpoint's access logging policy.
iostream transport error category
std::string get_query() const
Return the query portion.
bool is_ipv6_literal() const
Provides streaming UTF8 validation functionality.
bool decode(iterator_type begin, iterator_type end)
Advance validator state with input from an iterator pair.
validator()
Construct and initialize the validator.
bool complete()
Return whether the input sequence ended on a valid utf8 codepoint.
void reset()
Reset the validator to decode another message.
bool consume(uint8_t byte)
Advance the state of the validator with the next input byte.
#define _WEBSOCKETPP_CONSTEXPR_TOKEN_
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
A package of types and methods for manipulating WebSocket close status'.
static value const service_restart
static value const message_too_big
An endpoint received a message too large to process.
static value const try_again_later
static value const force_tcp_drop
Close the connection with a forced TCP drop.
static value const tls_handshake
An endpoint failed to perform a TLS handshake.
static value const rsv_end
Last value in range reserved for future protocol use.
static value const invalid_payload
An endpoint received message data inconsistent with its type.
bool terminal(value code)
Determine if the code represents an unrecoverable error.
static value const protocol_error
A protocol error occurred.
std::string get_string(value code)
Return a human readable interpretation of a WebSocket close code.
static value const bad_gateway
static value const invalid_subprotocol_data
A invalid subprotocol data.
static value const invalid_high
Last value in range that is always invalid on the wire.
static value const unsupported_data
static value const no_status
A dummy value to indicate that no status code was received.
static value const omit_handshake
Close the connection without a WebSocket close handshake.
static value const normal
static value const blank
A blank value for internal use.
static value const invalid_low
First value in range that is always invalid on the wire.
static value const abnormal_close
A dummy value to indicate that the connection was closed abnormally.
static value const rsv_start
First value in range reserved for future protocol use.
uint16_t value
The type of a close code value.
static value const policy_violation
An endpoint received a message that violated its policy.
static value const extension_required
A client expected the server to accept a required extension request.
bool invalid(value code)
Test whether a close code is invalid on the wire.
static value const internal_endpoint_error
static value const subprotocol_error
A generic subprotocol error.
bool reserved(value code)
Test whether a close code is in a reserved range.
static value const going_away
A package of types and methods for manipulating WebSocket close codes.
Concurrency handling support.
Library level error codes.
@ general
Catch-all library error.
@ unrequested_subprotocol
Selected subprotocol was not requested by the client.
@ invalid_port
Invalid port in URI.
@ client_only
Attempted to use a client specific feature on a server endpoint.
@ http_connection_ended
HTTP connection ended.
@ async_accept_not_listening
@ operation_canceled
The requested operation was canceled.
@ no_outgoing_buffers
The endpoint is out of outgoing message buffers.
@ http_parse_error
HTTP parse error.
@ reserved_close_code
Close code is in a reserved range.
@ con_creation_failed
Connection creation attempted failed.
@ no_incoming_buffers
The endpoint is out of incoming message buffers.
@ invalid_state
The connection was in the wrong state for this operation.
@ extension_neg_failed
Extension negotiation failed.
@ rejected
Connection rejected.
@ unsupported_version
Unsupported WebSocket protocol version.
@ invalid_utf8
Invalid UTF-8.
@ invalid_close_code
Close code is invalid.
@ server_only
Attempted to use a server specific feature on a client endpoint.
@ endpoint_not_secure
Attempted to open a secure connection with an insecure endpoint.
@ close_handshake_timeout
WebSocket close handshake timed out.
@ invalid_subprotocol
Invalid subprotocol.
@ bad_close_code
Unable to parse close code.
@ open_handshake_timeout
WebSocket opening handshake timed out.
@ invalid_version
Invalid WebSocket protocol version.
@ transport_error
General transport error, consult more specific transport error code.
@ send_queue_full
send attempted when endpoint write queue was full
@ test
Unit testing utility error code.
@ invalid_uri
An invalid uri was supplied.
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Constants related to frame and payload limits.
static uint8_t const close_reason_size
Maximum size of close frame reason.
static uint64_t const payload_size_jumbo
Maximum size of a jumbo WebSocket payload (basic payload = 127).
static unsigned int const max_extended_header_length
Maximum length of the variable portion of the WebSocket header.
static unsigned int const max_header_length
Maximum length of a WebSocket header.
static uint16_t const payload_size_extended
Maximum size of an extended WebSocket payload (basic payload = 126).
static uint8_t const payload_size_basic
Maximum size of a basic WebSocket payload.
static unsigned int const basic_header_length
Minimum length of a WebSocket frame header.
Constants and utility functions related to WebSocket opcodes.
bool invalid(value v)
Check if an opcode is invalid.
bool reserved(value v)
Check if an opcode is reserved.
bool is_control(value v)
Check if an opcode is for a control frame.
Data structures and utility functions for manipulating WebSocket frames.
unsigned int get_masking_key_offset(basic_header const &)
Calculate the offset location of the masking key within the extended header.
void set_rsv2(basic_header &h, bool value)
Set the frame's RSV2 bit.
static unsigned int const MAX_HEADER_LENGTH
Maximum length of a WebSocket header.
opcode::value get_opcode(basic_header const &h)
Extract opcode from basic header.
void set_rsv3(basic_header &h, bool value)
Set the frame's RSV3 bit.
uint64_t get_payload_size(basic_header const &, extended_header const &)
Extract the full payload size field from a WebSocket header.
uint8_t get_basic_size(basic_header const &)
Extracts the raw payload length specified in the basic header.
size_t byte_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask.
void byte_mask(input_iter b, input_iter e, output_iter o, masking_key_type const &key, size_t key_offset=0)
Byte by byte mask/unmask.
static unsigned int const MAX_EXTENDED_HEADER_LENGTH
Maximum length of the variable portion of the WebSocket header.
bool get_rsv3(basic_header const &h)
check whether the frame's RSV3 bit is set
bool get_masked(basic_header const &h)
check whether the frame is masked
bool get_rsv2(basic_header const &h)
check whether the frame's RSV2 bit is set
void byte_mask(iter_type b, iter_type e, masking_key_type const &key, size_t key_offset=0)
Byte by byte mask/unmask (in place).
uint16_t get_extended_size(extended_header const &)
Extract the extended size field from an extended header.
size_t byte_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask (in place).
bool get_fin(basic_header const &h)
Check whether the frame's FIN bit is set.
size_t circshift_prepared_key(size_t prepared_key, size_t offset)
circularly shifts the supplied prepared masking key by offset bytes
bool get_rsv1(basic_header const &h)
check whether the frame's RSV1 bit is set
void set_masked(basic_header &h, bool value)
Set the frame's MASK bit.
size_t word_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular word aligned mask/unmask.
void word_mask_exact(uint8_t *data, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask (in place).
void set_rsv1(basic_header &h, bool value)
Set the frame's RSV1 bit.
size_t get_header_len(basic_header const &)
Calculates the full length of the header based on the first bytes.
void set_fin(basic_header &h, bool value)
Set the frame's FIN bit.
uint64_t get_jumbo_size(extended_header const &)
Extract the jumbo size field from an extended header.
void word_mask_exact(uint8_t *input, uint8_t *output, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask.
std::string prepare_header(const basic_header &h, const extended_header &e)
Generate a properly sized contiguous string that encodes a full frame header.
masking_key_type get_masking_key(basic_header const &, extended_header const &)
Extract the masking key from a frame header.
static unsigned int const BASIC_HEADER_LENGTH
Minimum length of a WebSocket frame header.
size_t word_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular word aligned mask/unmask (in place).
size_t prepare_masking_key(masking_key_type const &key)
Extract a masking key into a value the size of a machine word.
status_code::value get_status_code(error::value value)
Get the HTTP status code associated with the error.
lib::error_category const & get_category()
Get a reference to a static copy of the asio transport error category.
@ unknown_transfer_encoding
The transfer encoding is unknown.
@ istream_bad
An istream read command returned with the bad flag set.
@ invalid_format
The specified data contains illegal characters for the context.
@ body_too_large
The body value is larger than the configured maximum size.
@ incomplete_request
The request was missing some required values.
@ unsupported_transfer_encoding
The transfer encoding is not supported.
@ incomplete_status_line
The response status line was missing some required values.
@ missing_header_separator
A header line was missing a separator.
@ invalid_header_name
The header name specified contains illegal characters.
@ request_header_fields_too_large
The request headers are larger than the configured maximum size.
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
std::string get_string(value code)
Given a status code value, return the default status message.
value
Known values for HTTP Status codes.
size_t const max_body_size
Default Maximum size in bytes for HTTP message bodies.
static char const header_separator[]
Literal value of the HTTP header separator.
std::vector< std::pair< std::string, attribute_list > > parameter_list
The type of an HTTP parameter list.
size_t const istream_buffer
Number of bytes to use for temporary istream read buffers.
bool is_not_token_char(unsigned char c)
Is the character a non-token.
size_t const max_header_size
Maximum size in bytes before rejecting an HTTP header as too big.
static char const header_delimiter[]
Literal value of the HTTP header delimiter.
bool is_whitespace_char(unsigned char c)
Is the character whitespace.
static char const header_token[]
invalid HTTP token characters
bool is_not_whitespace_char(unsigned char c)
Is the character non-whitespace.
std::map< std::string, std::string > attribute_list
The type of an HTTP attribute list.
bool is_token_char(unsigned char c)
Is the character a token.
static std::string const empty_header
Literal value of an empty header.
Constants related to processing WebSocket connections.
Processor class related error codes.
Error code category and codes used by all processor types.
lib::error_category const & get_processor_category()
Get a reference to a static copy of the processor error category.
close::status::value to_ws(lib::error_code ec)
Converts a processor error_code into a websocket close code.
@ missing_required_header
Missing Required Header.
@ control_too_big
Control frame too large.
@ invalid_http_method
Invalid HTTP method.
@ invalid_rsv_bit
Illegal use of reserved bit.
@ reason_requires_code
Using a reason requires a close code.
@ invalid_close_code
Invalid close code used.
@ masking_required
Clients may not send unmasked frames.
@ protocol_violation
Processor encountered a protocol violation in an incoming message.
@ extensions_disabled
Extension related operation was ignored because extensions are disabled.
@ reserved_close_code
Reserved close code used.
@ extension_parse_error
Error parsing extensions.
@ masking_forbidden
Servers may not send masked frames.
@ not_implemented
Operation required not implemented functionality.
@ invalid_opcode
Opcode was invalid for requested operation.
@ sha1_library
Embedded SHA-1 library error.
@ requires_64bit
Not supported on 32 bit systems.
@ subprotocol_parse_error
Error parsing subprotocols.
@ bad_request
Error was the result of improperly formatted user input.
@ invalid_utf8
Invalid UTF-8 encoding.
@ invalid_http_status
Invalid HTTP status.
@ invalid_payload
Processor encountered invalid payload data.
@ invalid_http_version
Invalid HTTP version.
@ message_too_big
Processor encountered a message that was too large.
@ no_protocol_support
No support for this feature in this protocol version.
@ invalid_arguments
The processor method was called with invalid arguments.
@ invalid_continuation
Continuation without message.
@ non_minimal_encoding
Payload length not minimally encoded.
@ fragmented_control
Fragmented control message.
lib::error_code make_error_code(error::processor_errors e)
Create an error code with the given value and the processor category.
Processors encapsulate the protocol rules specific to each WebSocket version.
int get_websocket_version(request_type &r)
Extract the version from a WebSocket handshake request.
bool is_websocket_handshake(request_type &r)
Determine whether or not a generic HTTP request is a WebSocket handshake.
Stub RNG policy that always returns 0.
Random number generation policies.
lib::function< void(connection_hdl, lib::asio::ip::tcp::socket &)> socket_init_handler
The signature of the socket init handler for this socket policy.
lib::error_category const & get_category()
Get a reference to a static copy of the asio transport error category.
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
@ proxy_invalid
Invalid Proxy URI.
@ pass_through
there was an error in the underlying transport library
@ proxy_failed
The connection to the requested proxy server failed.
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
@ invalid_host_service
Invalid host or service.
Errors related to asio transport sockets.
@ missing_tls_init_handler
Required tls_init handler not present.
@ invalid_state
A function was called in a state that it was illegal to do so.
@ tls_failed_sni_hostname
Failed to set TLS SNI hostname.
@ tls_handshake_failed
TLS Handshake Failed.
@ tls_handshake_timeout
TLS Handshake Timeout.
@ pass_through
pass_through from underlying library
Transport policy that uses asio.
Generic transport related errors.
@ pass_through
underlying transport pass through
@ operation_not_supported
Operation not supported.
@ operation_aborted
Operation aborted.
@ tls_error
Other TLS error.
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
@ action_after_shutdown
read or write after shutdown
@ tls_short_read
TLS short read.
@ double_read
async_read called while another async_read was in progress
iostream transport errors
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
@ double_read
async_read called while another async_read was in progress
lib::error_code make_error_code(error::value e)
Get an error code with the given value and the iostream transport category.
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Transport policy that uses STL iostream for I/O and does not support timers.
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
lib::function< lib::error_code(connection_hdl)> shutdown_handler
lib::function< lib::error_code(connection_hdl, char const *, size_t)> write_handler
The type and signature of the callback used by iostream transport to write.
Transport policies provide network connectivity and timers.
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
lib::function< void(lib::error_code const &)> accept_handler
The type and signature of the callback passed to the accept method.
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
lib::function< void(lib::error_code const &)> connect_handler
The type and signature of the callback passed to the connect method.
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
A group of helper methods for parsing and validating URIs against RFC 3986.
bool digit(char c)
RFC3986 digit character test.
bool gen_delim(char c)
RFC3986 generic delimiter character test.
bool digit(std::string::const_iterator it)
RFC3986 digit character test (iterator version).
bool ipv4_literal(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv4 literal.
bool sub_delim(char c)
RFC3986 subcomponent delimiter character test.
bool reg_name(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for validity for a registry name.
bool pct_encoded(std::string::const_iterator it)
RFC3986 per cent encoded character test.
bool scheme(char c)
RFC3986 scheme character test.
bool unreserved(char c)
RFC3986 unreserved character test.
bool reg_name(char c)
Tests a character for validity for a registry name.
bool hex4(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv6 hex quad.
bool dec_octet(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv4 decimal octet.
bool ipv6_literal(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv6 literal.
bool hexdigit(char c)
RFC3986 hex digit character test.
Generic non-websocket specific utility functions and data structures.
std::string to_hex(uint8_t const *input, size_t length)
Convert byte array (uint8_t) to ascii printed string of hex digits.
T::const_iterator ci_find_substr(T const &haystack, T const &needle, std::locale const &loc=std::locale())
Find substring (case insensitive).
T::const_iterator ci_find_substr(T const &haystack, typename T::value_type const *needle, typename T::size_type size, std::locale const &loc=std::locale())
Find substring (case insensitive).
std::string to_hex(char const *input, size_t length)
Convert char array to ascii printed string of hex digits.
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.
static uint16_t const uri_default_secure_port
Default port for wss://.
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.
static uint16_t const uri_default_port
Default port for ws://.
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::shared_ptr< uri > uri_ptr
Pointer to a URI.
std::pair< lib::error_code, std::string > err_str_pair
Combination error code / string type for returning two values.
lib::function< bool(connection_hdl)> validate_handler
The type and function signature of a validate handler.
static bool is_base64(unsigned char c)
Test whether a character is a valid base64 character.
std::string base64_encode(unsigned char const *input, size_t len)
Encode a char buffer into a base64 string.
Server config with asio transport and TLS disabled.
Extension specific settings:
static const uint8_t minimum_outgoing_window_bits
static const bool allow_disabling_context_takeover
Maximum size (in bytes) of a decompressed message.
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
static const long timeout_connect
Length of time to wait for TCP connect.
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
static const long timeout_socket_pre_init
Default timer values (in ms).
static bool const enable_multithreading
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Server config with iostream transport.
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
static const websocketpp::log::level elog_level
Default static error logging channels.
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
static const size_t max_http_body_size
Default maximum http body size.
static const long timeout_open_handshake
Default timer values (in ms).
static const size_t max_message_size
Default maximum message size.
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
static const websocketpp::log::level alog_level
Default static access logging channels.
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
static const long timeout_pong
Length of time to wait for a pong after a ping.
static const bool silent_close
Suppresses the return of detailed connection close information.
static bool const enable_multithreading
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
static const bool enable_extensions
Global flag for enabling/disabling extensions.
static const int client_version
WebSocket Protocol version to use as a client.
Package of log levels for logging access events.
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
static level const fail
One line for each failed WebSocket connection with details.
static level const none
Special aggregate value representing "no levels".
static level const debug_handshake
Extra information about opening handshakes.
static level const devel
Development messages (warning: very chatty).
static level const all
Special aggregate value representing "all levels".
static level const debug_close
Extra information about closing handshakes.
static level const frame_payload
One line per frame, includes the full message payload (warning: chatty).
static level const connect
Information about new connections.
static level const app
Special channel for application specific logs. Not used by the library.
static level const frame_header
One line per frame, includes the full frame header.
static level const message_payload
Reserved.
static level const endpoint
Reserved.
static level const message_header
Reserved.
static level const control
One line per control frame.
static level const disconnect
One line for each closed connection. Includes closing codes and reasons.
static level const access_core
static level const http
Access related to HTTP requests.
Package of values for hinting at the nature of a given logger.
static value const none
No information.
static value const access
Access log.
static value const error
Error log.
uint32_t value
Type of a channel type hint value.
Package of log levels for logging errors.
static level const devel
Low level debugging information (warning: very chatty).
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
static level const library
static level const all
Special aggregate value representing "all levels".
static level const none
Special aggregate value representing "no levels".
static level const rerror
A simple utility buffer class.
Helper less than functor for case insensitive find.
Helper functor for case insensitive find.
bool operator()(charT ch1, charT ch2)
Perform a case insensitive comparison.
my_equal(std::locale const &loc)
Construct the functor with the given locale.
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
Type used to convert close statuses between integer and wire representations.
Two byte conversion union.
Four byte conversion union.
Eight byte conversion union.