WebSocket++ 0.8.3-dev
C++ websocket client/server library
Loading...
Searching...
No Matches
connection_impl.hpp
1/*
2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution.
11 * * Neither the name of the WebSocket++ Project nor the
12 * names of its contributors may be used to endorse or promote products
13 * derived from this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 */
27
28#ifndef WEBSOCKETPP_CONNECTION_IMPL_HPP
29#define WEBSOCKETPP_CONNECTION_IMPL_HPP
30
31#include <websocketpp/processors/hybi00.hpp>
32#include <websocketpp/processors/hybi07.hpp>
33#include <websocketpp/processors/hybi08.hpp>
34#include <websocketpp/processors/hybi13.hpp>
35
36#include <websocketpp/processors/processor.hpp>
37
38#include <websocketpp/common/platforms.hpp>
39#include <websocketpp/common/system_error.hpp>
40
41#include <algorithm>
42#include <exception>
43#include <sstream>
44#include <string>
45#include <utility>
46#include <vector>
47
48namespace websocketpp {
49
50namespace istate = session::internal_state;
51
52template <typename config>
54 termination_handler new_handler)
55{
56 m_alog->write(log::alevel::devel,
57 "connection set_termination_handler");
58
59 //scoped_lock_type lock(m_connection_state_lock);
60
61 m_termination_handler = new_handler;
62}
63
64template <typename config>
65std::string const & connection<config>::get_origin() const {
66 //scoped_lock_type lock(m_connection_state_lock);
67 return m_processor->get_origin(m_request);
68}
69
70template <typename config>
72 //scoped_lock_type lock(m_connection_state_lock);
73 return m_send_buffer_size;
74}
75
76template <typename config>
77session::state::value connection<config>::get_state() const {
78 //scoped_lock_type lock(m_connection_state_lock);
79 return m_state;
80}
81
82template <typename config>
83lib::error_code connection<config>::send(std::string const & payload,
84 frame::opcode::value op)
85{
86 message_ptr msg = m_msg_manager->get_message(op,payload.size());
87 msg->append_payload(payload);
88 msg->set_compressed(true);
89
90 return send(msg);
91}
92
93template <typename config>
94lib::error_code connection<config>::send(void const * payload, size_t len,
95 frame::opcode::value op)
96{
97 message_ptr msg = m_msg_manager->get_message(op,len);
98 msg->append_payload(payload,len);
99
100 return send(msg);
101}
102
103template <typename config>
104lib::error_code connection<config>::send(typename config::message_type::ptr msg)
105{
106 if (m_alog->static_test(log::alevel::devel)) {
107 m_alog->write(log::alevel::devel,"connection send");
108 }
109
110 {
111 scoped_lock_type lock(m_connection_state_lock);
112 if (m_state != session::state::open) {
113 return error::make_error_code(error::invalid_state);
114 }
115 }
116
117 message_ptr outgoing_msg;
118 bool needs_writing = false;
119
120 if (msg->get_prepared()) {
121 outgoing_msg = msg;
122
123 scoped_lock_type lock(m_write_lock);
124 write_push(outgoing_msg);
125 needs_writing = !m_write_flag && !m_send_queue.empty();
126 } else {
127 outgoing_msg = m_msg_manager->get_message();
128
129 if (!outgoing_msg) {
130 return error::make_error_code(error::no_outgoing_buffers);
131 }
132
133 scoped_lock_type lock(m_write_lock);
134 lib::error_code ec = m_processor->prepare_data_frame(msg,outgoing_msg);
135
136 if (ec) {
137 return ec;
138 }
139
140 write_push(outgoing_msg);
141 needs_writing = !m_write_flag && !m_send_queue.empty();
142 }
143
144 if (needs_writing) {
145 transport_con_type::dispatch(lib::bind(
148 ));
149 }
150
151 return lib::error_code();
152}
153
154template <typename config>
155void connection<config>::ping(std::string const& payload, lib::error_code& ec) {
156 if (m_alog->static_test(log::alevel::devel)) {
157 m_alog->write(log::alevel::devel,"connection ping");
158 }
159
160 {
161 scoped_lock_type lock(m_connection_state_lock);
162 if (m_state != session::state::open) {
163 std::stringstream ss;
164 ss << "connection::ping called from invalid state " << m_state;
165 m_alog->write(log::alevel::devel,ss.str());
166 ec = error::make_error_code(error::invalid_state);
167 return;
168 }
169 }
170
171 message_ptr msg = m_msg_manager->get_message();
172 if (!msg) {
173 ec = error::make_error_code(error::no_outgoing_buffers);
174 return;
175 }
176
177 ec = m_processor->prepare_ping(payload,msg);
178 if (ec) {return;}
179
180 // set ping timer if we are listening for one
181 if (m_pong_timeout_handler) {
182 // Cancel any existing timers
183 if (m_ping_timer) {
184 m_ping_timer->cancel();
185 }
186
187 if (m_pong_timeout_dur > 0) {
188 m_ping_timer = transport_con_type::set_timer(
189 m_pong_timeout_dur,
190 lib::bind(
191 &type::handle_pong_timeout,
193 payload,
194 lib::placeholders::_1
195 )
196 );
197 }
198
199 if (!m_ping_timer) {
200 // Our transport doesn't support timers
201 m_elog->write(log::elevel::warn,"Warning: a pong_timeout_handler is \
202 set but the transport in use does not support timeouts.");
203 }
204 }
205
206 bool needs_writing = false;
207 {
208 scoped_lock_type lock(m_write_lock);
209 write_push(msg);
210 needs_writing = !m_write_flag && !m_send_queue.empty();
211 }
212
213 if (needs_writing) {
214 transport_con_type::dispatch(lib::bind(
217 ));
218 }
219
220 ec = lib::error_code();
221}
222
223#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
224template<typename config>
225void connection<config>::ping(std::string const & payload) {
226 lib::error_code ec;
227 ping(payload,ec);
228 if (ec) {
229 throw exception(ec);
230 }
231}
232#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
233
234template<typename config>
235void connection<config>::handle_pong_timeout(std::string payload,
236 lib::error_code const & ec)
237{
238 if (ec) {
240 // ignore, this is expected
241 return;
242 }
243
244 m_elog->write(log::elevel::devel,"pong_timeout error: "+ec.message());
245 return;
246 }
247
248 if (m_pong_timeout_handler) {
249 m_pong_timeout_handler(m_connection_hdl,payload);
250 }
251}
252
253template <typename config>
254void connection<config>::pong(std::string const& payload, lib::error_code& ec) {
255 if (m_alog->static_test(log::alevel::devel)) {
256 m_alog->write(log::alevel::devel,"connection pong");
257 }
258
259 {
260 scoped_lock_type lock(m_connection_state_lock);
261 if (m_state != session::state::open) {
262 std::stringstream ss;
263 ss << "connection::pong called from invalid state " << m_state;
264 m_alog->write(log::alevel::devel,ss.str());
265 ec = error::make_error_code(error::invalid_state);
266 return;
267 }
268 }
269
270 message_ptr msg = m_msg_manager->get_message();
271 if (!msg) {
272 ec = error::make_error_code(error::no_outgoing_buffers);
273 return;
274 }
275
276 ec = m_processor->prepare_pong(payload,msg);
277 if (ec) {return;}
278
279 bool needs_writing = false;
280 {
281 scoped_lock_type lock(m_write_lock);
282 write_push(msg);
283 needs_writing = !m_write_flag && !m_send_queue.empty();
284 }
285
286 if (needs_writing) {
287 transport_con_type::dispatch(lib::bind(
290 ));
291 }
292
293 ec = lib::error_code();
294}
295
296#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
297template<typename config>
298void connection<config>::pong(std::string const & payload) {
299 lib::error_code ec;
300 pong(payload,ec);
301 if (ec) {
302 throw exception(ec);
303 }
304}
305#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
306
307template <typename config>
308void connection<config>::close(close::status::value const code,
309 std::string const & reason, lib::error_code & ec)
310{
311 if (m_alog->static_test(log::alevel::devel)) {
312 m_alog->write(log::alevel::devel,"connection close");
313 }
314
315 // Truncate reason to maximum size allowable in a close frame.
316 std::string tr(reason,0,std::min<size_t>(reason.size(),
317 frame::limits::close_reason_size));
318
319 scoped_lock_type lock(m_connection_state_lock);
320
321 if (m_state != session::state::open) {
322 ec = error::make_error_code(error::invalid_state);
323 return;
324 }
325
326 ec = this->send_close_frame(code,tr,false,close::status::terminal(code));
327}
328
329#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
330template<typename config>
331void connection<config>::close(close::status::value const code,
332 std::string const & reason)
333{
334 lib::error_code ec;
335 close(code,reason,ec);
336 if (ec) {
337 throw exception(ec);
338 }
339}
340#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
341
342/// Trigger the on_interrupt handler
343/**
344 * This is thread safe if the transport is thread safe
345 */
346template <typename config>
347lib::error_code connection<config>::interrupt() {
348 m_alog->write(log::alevel::devel,"connection connection::interrupt");
349 return transport_con_type::interrupt(
350 lib::bind(
353 )
354 );
355}
356
357
358template <typename config>
360 if (m_interrupt_handler) {
361 m_interrupt_handler(m_connection_hdl);
362 }
363}
364
365template <typename config>
366lib::error_code connection<config>::pause_reading() {
367 m_alog->write(log::alevel::devel,"connection connection::pause_reading");
368 return transport_con_type::dispatch(
369 lib::bind(
372 )
373 );
374}
375
376/// Pause reading handler. Not safe to call directly
377template <typename config>
379 m_alog->write(log::alevel::devel,"connection connection::handle_pause_reading");
380 m_read_flag = false;
381}
382
383template <typename config>
384lib::error_code connection<config>::resume_reading() {
385 m_alog->write(log::alevel::devel,"connection connection::resume_reading");
386 return transport_con_type::dispatch(
387 lib::bind(
390 )
391 );
392}
393
394/// Resume reading helper method. Not safe to call directly
395template <typename config>
397 m_read_flag = true;
399}
400
401
402
403
404
405
406
407
408
409
410
411template <typename config>
412bool connection<config>::get_secure() const {
413 //scoped_lock_type lock(m_connection_state_lock);
414 return m_uri->get_secure();
415}
416
417template <typename config>
418std::string const & connection<config>::get_host() const {
419 //scoped_lock_type lock(m_connection_state_lock);
420 return m_uri->get_host();
421}
422
423template <typename config>
424std::string const & connection<config>::get_resource() const {
425 //scoped_lock_type lock(m_connection_state_lock);
426 return m_uri->get_resource();
427}
428
429template <typename config>
430uint16_t connection<config>::get_port() const {
431 //scoped_lock_type lock(m_connection_state_lock);
432 return m_uri->get_port();
433}
434
435template <typename config>
436uri_ptr connection<config>::get_uri() const {
437 //scoped_lock_type lock(m_connection_state_lock);
438 return m_uri;
439}
440
441template <typename config>
442void connection<config>::set_uri(uri_ptr uri) {
443 //scoped_lock_type lock(m_connection_state_lock);
444 m_uri = uri;
445}
446
447
448
449
450
451
452template <typename config>
453std::string const & connection<config>::get_subprotocol() const {
454 return m_subprotocol;
455}
456
457template <typename config>
458std::vector<std::string> const &
460 return m_requested_subprotocols;
461}
462
463template <typename config>
464void connection<config>::add_subprotocol(std::string const & value,
465 lib::error_code & ec)
466{
467 if (m_is_server) {
468 ec = error::make_error_code(error::client_only);
469 return;
470 }
471
472 // If the value is empty or has a non-RFC2616 token character it is invalid.
473 if (value.empty() || std::find_if(value.begin(),value.end(),
474 http::is_not_token_char) != value.end())
475 {
476 ec = error::make_error_code(error::invalid_subprotocol);
477 return;
478 }
479
480 m_requested_subprotocols.push_back(value);
481}
482
483#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
484template <typename config>
485void connection<config>::add_subprotocol(std::string const & value) {
486 lib::error_code ec;
487 this->add_subprotocol(value,ec);
488 if (ec) {
489 throw exception(ec);
490 }
491}
492#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
493
494
495template <typename config>
496void connection<config>::select_subprotocol(std::string const & value,
497 lib::error_code & ec)
498{
499 if (!m_is_server) {
500 ec = error::make_error_code(error::server_only);
501 return;
502 }
503
504 if (value.empty()) {
505 ec = lib::error_code();
506 return;
507 }
508
509 std::vector<std::string>::iterator it;
510
511 it = std::find(m_requested_subprotocols.begin(),
512 m_requested_subprotocols.end(),
513 value);
514
515 if (it == m_requested_subprotocols.end()) {
516 ec = error::make_error_code(error::unrequested_subprotocol);
517 return;
518 }
519
520 m_subprotocol = value;
521 ec = lib::error_code();
522}
523
524#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
525template <typename config>
526void connection<config>::select_subprotocol(std::string const & value) {
527 lib::error_code ec;
528 this->select_subprotocol(value,ec);
529 if (ec) {
530 throw exception(ec);
531 }
532}
533#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
534
535
536template <typename config>
537std::string const &
538connection<config>::get_request_header(std::string const & key) const {
539 return m_request.get_header(key);
540}
541
542template <typename config>
543std::string const &
544connection<config>::get_request_body() const {
545 return m_request.get_body();
546}
547
548template <typename config>
549std::string const &
550connection<config>::get_response_header(std::string const & key) const {
551 return m_response.get_header(key);
552}
553
554template <typename config>
556 lib::error_code & ec)
557{
558 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
559 ec = error::make_error_code(error::invalid_state);
560 return;
561 }
562 ec = m_response.set_status(code);
563}
564
565#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
566template <typename config>
568{
569 lib::error_code ec;
570 this->set_status(code, ec);
571 if (ec) {
572 throw exception("Call to set_status from invalid state", ec);
573 }
574}
575#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
576
577template <typename config>
578void connection<config>::set_status(http::status_code::value code,
579 std::string const & msg, lib::error_code & ec)
580{
581 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
582 ec = error::make_error_code(error::invalid_state);
583 return;
584 }
585
586 ec = m_response.set_status(code,msg);
587}
588
589#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
590template <typename config>
591void connection<config>::set_status(http::status_code::value code,
592 std::string const & msg)
593{
594 lib::error_code ec;
595 this->set_status(code, msg);
596 if (ec) {
597 throw exception("Call to set_status from invalid state", ec);
598 }
599}
600#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
601
602template <typename config>
603void connection<config>::set_body(std::string const & value,
604 lib::error_code & ec)
605{
606 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
607 ec = error::make_error_code(error::invalid_state);
608 return;
609 }
610
611 ec = m_response.set_body(value);
612}
613
614#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
615template <typename config>
616void connection<config>::set_body(std::string const & value) {
617 lib::error_code ec;
618 this->set_body(value, ec);
619 if (ec) {
620 throw exception("Call to set_body from invalid state", ec);
621 }
622}
623#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
624
625#ifdef _WEBSOCKETPP_MOVE_SEMANTICS_
626template <typename config>
627void connection<config>::set_body(std::string && value,
628 lib::error_code & ec)
629{
630 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
631 ec = error::make_error_code(error::invalid_state);
632 return;
633 }
634
635 ec = m_response.set_body(std::move(value));
636}
637
638#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
639template <typename config>
640void connection<config>::set_body(std::string && value) {
641 lib::error_code ec;
642 this->set_body(std::move(value), ec);
643 if (ec) {
644 throw exception("Call to set_body from invalid state", ec);
645 }
646}
647#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
648#endif // _WEBSOCKETPP_MOVE_SEMANTICS_
649
650template <typename config>
651void connection<config>::append_header(std::string const & key,
652 std::string const & val, lib::error_code & ec)
653{
654 if (m_is_server) {
655 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
656 // we are setting response headers for an incoming server connection
657 ec = m_response.append_header(key, val);
658 } else {
659 ec = error::make_error_code(error::invalid_state);
660 }
661 } else {
662 if (m_internal_state == istate::USER_INIT) {
663 // we are setting initial headers for an outgoing client connection
664 ec = m_request.append_header(key, val);
665 } else {
666 ec = error::make_error_code(error::invalid_state);
667 }
668 }
669}
670
671#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
672template <typename config>
673void connection<config>::append_header(std::string const & key,
674 std::string const & val)
675{
676 lib::error_code ec;
677 this->append_header(key, val, ec);
678 if (ec) {
679 throw exception("Call to append_header from invalid state", ec);
680 }
681}
682#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
683
684template <typename config>
685void connection<config>::replace_header(std::string const & key,
686 std::string const & val, lib::error_code & ec)
687{
688 if (m_is_server) {
689 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
690 // we are setting response headers for an incoming server connection
691 ec = m_response.replace_header(key, val);
692 } else {
693 ec = error::make_error_code(error::invalid_state);
694 }
695 } else {
696 if (m_internal_state == istate::USER_INIT) {
697 // we are setting initial headers for an outgoing client connection
698 ec = m_request.replace_header(key, val);
699 } else {
700 ec = error::make_error_code(error::invalid_state);
701 }
702 }
703}
704
705#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
706template <typename config>
707void connection<config>::replace_header(std::string const & key,
708 std::string const & val)
709{
710 lib::error_code ec;
711 this->replace_header(key, val, ec);
712 if (ec) {
713 throw exception("Call to replace_header from invalid state", ec);
714 }
715}
716#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
717
718template <typename config>
719void connection<config>::remove_header(std::string const & key,
720 lib::error_code & ec)
721{
722 if (m_is_server) {
723 if (m_internal_state == istate::PROCESS_HTTP_REQUEST) {
724 // we are setting response headers for an incoming server connection
725 ec = m_response.remove_header(key);
726 } else {
727 ec = error::make_error_code(error::invalid_state);
728 }
729 } else {
730 if (m_internal_state == istate::USER_INIT) {
731 // we are setting initial headers for an outgoing client connection
732 ec = m_request.remove_header(key);
733 } else {
734 ec = error::make_error_code(error::invalid_state);
735 }
736 }
737}
738
739#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
740template <typename config>
741void connection<config>::remove_header(std::string const & key)
742{
743 lib::error_code ec;
744 this->remove_header(key, ec);
745 if (ec) {
746 throw exception("Call to remove_header from invalid state", ec);
747 }
748}
749#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
750
751/// Defer HTTP Response until later
752/**
753 * Used in the http handler to defer the HTTP response for this connection
754 * until later. Handshake timers will be canceled and the connection will be
755 * left open until `send_http_response` or an equivalent is called.
756 *
757 * Warning: deferred connections won't time out and as a result can tie up
758 * resources.
759 *
760 * @return A status code, zero on success, non-zero otherwise
761 */
762template <typename config>
763lib::error_code connection<config>::defer_http_response() {
764 // Cancel handshake timer, otherwise the connection will time out and we'll
765 // close the connection before the app has a chance to send a response.
766 if (m_handshake_timer) {
767 m_handshake_timer->cancel();
768 m_handshake_timer.reset();
769 }
770
771 // Do something to signal deferral
772 m_http_state = session::http_state::deferred;
773
774 return lib::error_code();
775}
776
777/// Send deferred HTTP Response (exception free)
778/**
779 * Sends an http response to an HTTP connection that was deferred. This will
780 * send a complete response including all headers, status line, and body
781 * text. The connection will be closed afterwards.
782 *
783 * @since 0.6.0
784 *
785 * @param ec A status code, zero on success, non-zero otherwise
786 */
787template <typename config>
788void connection<config>::send_http_response(lib::error_code & ec) {
789 {
790 scoped_lock_type lock(m_connection_state_lock);
791 if (m_http_state != session::http_state::deferred) {
792 ec = error::make_error_code(error::invalid_state);
793 return;
794 }
795
796 m_http_state = session::http_state::body_written;
797 }
798
799 this->write_http_response(lib::error_code());
800 ec = lib::error_code();
801}
802
803#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
804template <typename config>
806 lib::error_code ec;
807 this->send_http_response(ec);
808 if (ec) {
809 throw exception(ec);
810 }
811}
812#endif // _WEBSOCKETPP_NO_EXCEPTIONS_
813
814
815
816
817/******** logic thread ********/
818
819template <typename config>
820void connection<config>::start() {
821 m_alog->write(log::alevel::devel,"connection start");
822
823 if (m_internal_state != istate::USER_INIT) {
824 m_alog->write(log::alevel::devel,"Start called in invalid state");
825 this->terminate(error::make_error_code(error::invalid_state));
826 return;
827 }
828
829 m_internal_state = istate::TRANSPORT_INIT;
830
831 // Depending on how the transport implements init this function may return
832 // immediately and call handle_transport_init later or call
833 // handle_transport_init from this function.
834 transport_con_type::init(
835 lib::bind(
836 &type::handle_transport_init,
838 lib::placeholders::_1
839 )
840 );
841}
842
843template <typename config>
844void connection<config>::handle_transport_init(lib::error_code const & ec) {
845 m_alog->write(log::alevel::devel,"connection handle_transport_init");
846
847 lib::error_code ecm = ec;
848
849 if (m_internal_state != istate::TRANSPORT_INIT) {
850 m_alog->write(log::alevel::devel,
851 "handle_transport_init must be called from transport init state");
852 ecm = error::make_error_code(error::invalid_state);
853 }
854
855 if (ecm) {
856 std::stringstream s;
857 s << "handle_transport_init received error: "<< ecm.message();
858 m_elog->write(log::elevel::rerror,s.str());
859
860 this->terminate(ecm);
861 return;
862 }
863
864 // At this point the transport is ready to read and write bytes.
865 if (m_is_server) {
866 m_internal_state = istate::READ_HTTP_REQUEST;
867 this->read_handshake(1);
868 } else {
869 // We are a client. Set the processor to the version specified in the
870 // config file and send a handshake request.
871 m_internal_state = istate::WRITE_HTTP_REQUEST;
872 m_processor = get_processor(config::client_version);
873 this->send_http_request();
874 }
875}
876
877template <typename config>
878void connection<config>::read_handshake(size_t num_bytes) {
879 m_alog->write(log::alevel::devel,"connection read_handshake");
880
881 if (m_open_handshake_timeout_dur > 0) {
882 m_handshake_timer = transport_con_type::set_timer(
883 m_open_handshake_timeout_dur,
884 lib::bind(
885 &type::handle_open_handshake_timeout,
887 lib::placeholders::_1
888 )
889 );
890 }
891
892 transport_con_type::async_read_at_least(
893 num_bytes,
894 m_buf,
895 config::connection_read_buffer_size,
896 lib::bind(
897 &type::handle_read_handshake,
899 lib::placeholders::_1,
900 lib::placeholders::_2
901 )
902 );
903}
904
905// All exit paths for this function need to call write_http_response() or submit
906// a new read request with this function as the handler.
907template <typename config>
908void connection<config>::handle_read_handshake(lib::error_code const & ec,
909 size_t bytes_transferred)
910{
911 m_alog->write(log::alevel::devel,"connection handle_read_handshake");
912
913 lib::error_code ecm = ec;
914
915 if (!ecm) {
916 scoped_lock_type lock(m_connection_state_lock);
917
918 if (m_state == session::state::connecting) {
919 if (m_internal_state != istate::READ_HTTP_REQUEST) {
920 ecm = error::make_error_code(error::invalid_state);
921 }
922 } else if (m_state == session::state::closed) {
923 // The connection was canceled while the response was being sent,
924 // usually by the handshake timer. This is basically expected
925 // (though hopefully rare) and there is nothing we can do so ignore.
926 m_alog->write(log::alevel::devel,
927 "handle_read_handshake invoked after connection was closed");
928 return;
929 } else {
930 ecm = error::make_error_code(error::invalid_state);
931 }
932 }
933
934 if (ecm) {
935 if (ecm == transport::error::eof && m_state == session::state::closed) {
936 // we expect to get eof if the connection is closed already
937 m_alog->write(log::alevel::devel,
938 "got (expected) eof/state error from closed con");
939 return;
940 }
941
942 log_err(log::elevel::rerror,"handle_read_handshake",ecm);
943 this->terminate(ecm);
944 return;
945 }
946
947 // Boundaries checking. TODO: How much of this should be done?
948 if (bytes_transferred > config::connection_read_buffer_size) {
949 m_elog->write(log::elevel::fatal,"Fatal boundaries checking error.");
950 this->terminate(make_error_code(error::general));
951 return;
952 }
953
954 size_t bytes_processed = 0;
955 lib::error_code consume_ec;
956
957 bytes_processed = m_request.consume(m_buf, bytes_transferred, consume_ec);
958 if (consume_ec) {
959 // All HTTP errors will result in this request failing and an error
960 // response being returned. No more bytes will be read in this con.
961 m_response.set_status(http::error::get_status_code(http::error::value(consume_ec.value())));
962 log_err(log::elevel::fatal,"Fatal error reading request: ",consume_ec);
963 this->write_http_response_error(error::make_error_code(error::http_parse_error));
964 return;
965 }
966
967 // More paranoid boundaries checking.
968 // TODO: Is this overkill?
969 if (bytes_processed > bytes_transferred) {
970 m_elog->write(log::elevel::fatal,"Fatal boundaries checking error.");
971 this->terminate(make_error_code(error::general));
972 return;
973 }
974
975 if (m_alog->static_test(log::alevel::devel)) {
976 std::stringstream s;
977 s << "bytes_transferred: " << bytes_transferred
978 << " bytes, bytes processed: " << bytes_processed << " bytes";
979 m_alog->write(log::alevel::devel,s.str());
980 }
981
982 if (m_request.ready()) {
983 lib::error_code processor_ec = this->initialize_processor();
984 if (processor_ec) {
985 this->write_http_response_error(processor_ec);
986 return;
987 }
988
989 if (m_processor && m_processor->get_version() == 0) {
990 // Version 00 has an extra requirement to read some bytes after the
991 // handshake
992 if (bytes_transferred-bytes_processed >= 8) {
993 m_request.replace_header(
994 "Sec-WebSocket-Key3",
995 std::string(m_buf+bytes_processed,m_buf+bytes_processed+8)
996 );
997 bytes_processed += 8;
998 } else {
999 // TODO: need more bytes
1000 m_alog->write(log::alevel::devel,"short key3 read");
1001 m_response.set_status(http::status_code::internal_server_error);
1003 return;
1004 }
1005 }
1006
1007 if (m_alog->static_test(log::alevel::devel)) {
1008 m_alog->write(log::alevel::devel,m_request.raw());
1009 if (!m_request.get_header("Sec-WebSocket-Key3").empty()) {
1010 m_alog->write(log::alevel::devel,
1011 utility::to_hex(m_request.get_header("Sec-WebSocket-Key3")));
1012 }
1013 }
1014
1015 // The remaining bytes in m_buf are frame data. Copy them to the
1016 // beginning of the buffer and note the length. They will be read after
1017 // the handshake completes and before more bytes are read.
1018 std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
1019 m_buf_cursor = bytes_transferred-bytes_processed;
1020
1021
1022 m_internal_state = istate::PROCESS_HTTP_REQUEST;
1023
1024 // We have the complete request. Process it.
1025 lib::error_code handshake_ec = this->process_handshake_request();
1026
1027 // Write a response if this is a websocket connection or if it is an
1028 // HTTP connection for which the response has not been deferred or
1029 // started yet by a different system (i.e. still in init state).
1030 if (!m_is_http || m_http_state == session::http_state::init) {
1031 this->write_http_response(handshake_ec);
1032 }
1033 } else {
1034 // The HTTP parser reported that it was not ready and wants more data.
1035 // Assert that it actually consumed all the data present before overwriting
1036 // the buffer. This should always be the case.
1037 if (bytes_transferred != bytes_processed) {
1038 m_elog->write(log::elevel::fatal,"Assertion Failed: HTTP request parser failed to consume all bytes from a read request.");
1039 this->terminate(make_error_code(error::general));
1040 return;
1041 }
1042
1043 // read at least 1 more byte
1044 transport_con_type::async_read_at_least(
1045 1,
1046 m_buf,
1047 config::connection_read_buffer_size,
1048 lib::bind(
1049 &type::handle_read_handshake,
1051 lib::placeholders::_1,
1052 lib::placeholders::_2
1053 )
1054 );
1055 }
1056}
1057
1058// write_http_response requires the request to be fully read and the connection
1059// to be in the PROCESS_HTTP_REQUEST state. In some cases we can detect errors
1060// before the request is fully read (specifically at a point where we aren't
1061// sure if the hybi00 key3 bytes need to be read). This method sets the correct
1062// state and calls write_http_response
1063template <typename config>
1064void connection<config>::write_http_response_error(lib::error_code const & ec) {
1065 if (m_internal_state != istate::READ_HTTP_REQUEST) {
1066 m_alog->write(log::alevel::devel,
1067 "write_http_response_error called in invalid state");
1068 this->terminate(error::make_error_code(error::invalid_state));
1069 return;
1070 }
1071
1072 m_internal_state = istate::PROCESS_HTTP_REQUEST;
1073
1074 this->write_http_response(ec);
1075}
1076
1077// All exit paths for this function need to call write_http_response() or submit
1078// a new read request with this function as the handler.
1079template <typename config>
1080void connection<config>::handle_read_frame(lib::error_code const & ec,
1081 size_t bytes_transferred)
1082{
1083 //m_alog->write(log::alevel::devel,"connection handle_read_frame");
1084
1085 lib::error_code ecm = ec;
1086
1087 if (!ecm && m_internal_state != istate::PROCESS_CONNECTION) {
1088 ecm = error::make_error_code(error::invalid_state);
1089 }
1090
1091 if (ecm) {
1092 log::level echannel = log::elevel::rerror;
1093
1094 if (ecm == transport::error::eof) {
1095 if (m_state == session::state::closed) {
1096 // we expect to get eof if the connection is closed already
1097 // just ignore it
1098 m_alog->write(log::alevel::devel,"got eof from closed con");
1099 return;
1100 } else if (m_state == session::state::closing && !m_is_server) {
1101 // If we are a client we expect to get eof in the closing state,
1102 // this is a signal to terminate our end of the connection after
1103 // the closing handshake
1104 terminate(lib::error_code());
1105 return;
1106 }
1107 } else if (ecm == error::invalid_state) {
1108 // In general, invalid state errors in the closed state are the
1109 // result of handlers that were in the system already when the state
1110 // changed and should be ignored as they pose no problems and there
1111 // is nothing useful that we can do about them.
1112 if (m_state == session::state::closed) {
1113 m_alog->write(log::alevel::devel,
1114 "handle_read_frame: got invalid istate in closed state");
1115 return;
1116 }
1117 } else if (ecm == transport::error::action_after_shutdown) {
1118 echannel = log::elevel::info;
1119 } else {
1120 // TODO: more generally should we do something different here in the
1121 // case that m_state is cosed? Are errors after the connection is
1122 // already closed really an rerror?
1123 }
1124
1125
1126
1127 log_err(echannel, "handle_read_frame", ecm);
1128 this->terminate(ecm);
1129 return;
1130 }
1131
1132 // Boundaries checking. TODO: How much of this should be done?
1133 /*if (bytes_transferred > config::connection_read_buffer_size) {
1134 m_elog->write(log::elevel::fatal,"Fatal boundaries checking error");
1135 this->terminate(make_error_code(error::general));
1136 return;
1137 }*/
1138
1139 size_t p = 0;
1140
1141 if (m_alog->static_test(log::alevel::devel)) {
1142 std::stringstream s;
1143 s << "p = " << p << " bytes transferred = " << bytes_transferred;
1144 m_alog->write(log::alevel::devel,s.str());
1145 }
1146
1147 while (p < bytes_transferred) {
1148 if (m_alog->static_test(log::alevel::devel)) {
1149 std::stringstream s;
1150 s << "calling consume with " << bytes_transferred-p << " bytes";
1151 m_alog->write(log::alevel::devel,s.str());
1152 }
1153
1154 lib::error_code consume_ec;
1155
1156 if (m_alog->static_test(log::alevel::devel)) {
1157 std::stringstream s;
1158 s << "Processing Bytes: " << utility::to_hex(reinterpret_cast<uint8_t*>(m_buf)+p,bytes_transferred-p);
1159 m_alog->write(log::alevel::devel,s.str());
1160 }
1161
1162 p += m_processor->consume(
1163 reinterpret_cast<uint8_t*>(m_buf)+p,
1164 bytes_transferred-p,
1165 consume_ec
1166 );
1167
1168 if (m_alog->static_test(log::alevel::devel)) {
1169 std::stringstream s;
1170 s << "bytes left after consume: " << bytes_transferred-p;
1171 m_alog->write(log::alevel::devel,s.str());
1172 }
1173 if (consume_ec) {
1174 log_err(log::elevel::rerror, "consume", consume_ec);
1175
1176 if (config::drop_on_protocol_error) {
1177 this->terminate(consume_ec);
1178 return;
1179 } else {
1180 lib::error_code close_ec;
1181 this->close(
1182 processor::error::to_ws(consume_ec),
1183 consume_ec.message(),
1184 close_ec
1185 );
1186
1187 if (close_ec) {
1188 log_err(log::elevel::fatal, "Protocol error close frame ", close_ec);
1189 this->terminate(close_ec);
1190 return;
1191 }
1192 }
1193 return;
1194 }
1195
1196 if (m_processor->ready()) {
1197 if (m_alog->static_test(log::alevel::devel)) {
1198 std::stringstream s;
1199 s << "Complete message received. Dispatching";
1200 m_alog->write(log::alevel::devel,s.str());
1201 }
1202
1203 message_ptr msg = m_processor->get_message();
1204
1205 if (!msg) {
1206 m_alog->write(log::alevel::devel, "null message from m_processor");
1207 } else if (!is_control(msg->get_opcode())) {
1208 // data message, dispatch to user
1209 if (m_state != session::state::open) {
1210 m_elog->write(log::elevel::warn, "got non-close frame while closing");
1211 } else if (m_message_handler) {
1212 m_message_handler(m_connection_hdl, msg);
1213 }
1214 } else {
1215 process_control_frame(msg);
1216 }
1217 }
1218 }
1219
1221}
1222
1223/// Issue a new transport read unless reading is paused.
1224template <typename config>
1225void connection<config>::read_frame() {
1226 if (!m_read_flag) {
1227 return;
1228 }
1229
1230 transport_con_type::async_read_at_least(
1231 // std::min wont work with undefined static const values.
1232 // TODO: is there a more elegant way to do this?
1233 // Need to determine if requesting 1 byte or the exact number of bytes
1234 // is better here. 1 byte lets us be a bit more responsive at a
1235 // potential expense of additional runs through handle_read_frame
1236 /*(m_processor->get_bytes_needed() > config::connection_read_buffer_size ?
1237 config::connection_read_buffer_size : m_processor->get_bytes_needed())*/
1238 1,
1239 m_buf,
1240 config::connection_read_buffer_size,
1241 m_handle_read_frame
1242 );
1243}
1244
1245template <typename config>
1246lib::error_code connection<config>::initialize_processor() {
1247 m_alog->write(log::alevel::devel,"initialize_processor");
1248
1249 // if it isn't a websocket handshake nothing to do.
1250 if (!processor::is_websocket_handshake(m_request)) {
1251 return lib::error_code();
1252 }
1253
1254 int version = processor::get_websocket_version(m_request);
1255
1256 if (version < 0) {
1257 m_alog->write(log::alevel::devel, "BAD REQUEST: can't determine version");
1258 m_response.set_status(http::status_code::bad_request);
1259 return error::make_error_code(error::invalid_version);
1260 }
1261
1262 m_processor = get_processor(version);
1263
1264 // if the processor is not null we are done
1265 if (m_processor) {
1266 return lib::error_code();
1267 }
1268
1269 // We don't have a processor for this version. Return bad request
1270 // with Sec-WebSocket-Version header filled with values we do accept
1271 m_alog->write(log::alevel::devel, "BAD REQUEST: no processor for version");
1272 m_response.set_status(http::status_code::bad_request);
1273
1274 std::stringstream ss;
1275 std::string sep;
1276 std::vector<int>::const_iterator it;
1277 for (it = versions_supported.begin(); it != versions_supported.end(); it++)
1278 {
1279 ss << sep << *it;
1280 sep = ",";
1281 }
1282
1283 m_response.replace_header("Sec-WebSocket-Version",ss.str());
1284 return error::make_error_code(error::unsupported_version);
1285}
1286
1287template <typename config>
1288lib::error_code connection<config>::process_handshake_request() {
1289 m_alog->write(log::alevel::devel,"process handshake request");
1290
1291 if (!processor::is_websocket_handshake(m_request)) {
1292 // this is not a websocket handshake. Process as plain HTTP
1293 m_alog->write(log::alevel::devel,"HTTP REQUEST");
1294
1295 // extract URI from request
1296 m_uri = processor::get_uri_from_host(
1297 m_request,
1298 (transport_con_type::is_secure() ? "https" : "http")
1299 );
1300
1301 if (!m_uri->get_valid()) {
1302 m_alog->write(log::alevel::devel, "Bad request: failed to parse uri");
1303 m_response.set_status(http::status_code::bad_request);
1304 return error::make_error_code(error::invalid_uri);
1305 }
1306
1307 if (m_http_handler) {
1308 m_is_http = true;
1309 m_http_handler(m_connection_hdl);
1310
1311 if (m_state == session::state::closed) {
1312 return error::make_error_code(error::http_connection_ended);
1313 }
1314 } else {
1315 m_response.set_status(http::status_code::upgrade_required);
1316 return error::make_error_code(error::upgrade_required);
1317 }
1318
1319 return lib::error_code();
1320 }
1321
1322 lib::error_code ec = m_processor->validate_handshake(m_request);
1323
1324 // Validate: make sure all required elements are present.
1325 if (ec){
1326 // Not a valid handshake request
1327 m_alog->write(log::alevel::devel, "Bad request " + ec.message());
1328 m_response.set_status(http::status_code::bad_request);
1329 return ec;
1330 }
1331
1332 // Read extension parameters and set up values necessary for the end user
1333 // to complete extension negotiation.
1334 std::pair<lib::error_code,std::string> neg_results;
1335 neg_results = m_processor->negotiate_extensions(m_request);
1336
1338 // There was a fatal error in extension parsing that should result in
1339 // a failed connection attempt.
1340 m_elog->write(log::elevel::info, "Bad request: " + neg_results.first.message());
1341 m_response.set_status(http::status_code::bad_request);
1342 return neg_results.first;
1343 } else if (neg_results.first) {
1344 // There was a fatal error in extension processing that is probably our
1345 // fault. Consider extension negotiation to have failed and continue as
1346 // if extensions were not supported
1347 m_elog->write(log::elevel::info,
1348 "Extension negotiation failed: " + neg_results.first.message());
1349 } else {
1350 // extension negotiation succeeded, set response header accordingly
1351 // we don't send an empty extensions header because it breaks many
1352 // clients.
1353 if (neg_results.second.size() > 0) {
1354 m_response.replace_header("Sec-WebSocket-Extensions",
1355 neg_results.second);
1356 }
1357 }
1358
1359 // extract URI from request
1360 m_uri = m_processor->get_uri(m_request);
1361
1362
1363 if (!m_uri->get_valid()) {
1364 m_alog->write(log::alevel::devel, "Bad request: failed to parse uri");
1365 m_response.set_status(http::status_code::bad_request);
1366 return error::make_error_code(error::invalid_uri);
1367 }
1368
1369 // extract subprotocols
1370 lib::error_code subp_ec = m_processor->extract_subprotocols(m_request,
1371 m_requested_subprotocols);
1372
1373 if (subp_ec) {
1374 // should we do anything?
1375 }
1376
1377 // Ask application to validate the connection
1378 if (!m_validate_handler || m_validate_handler(m_connection_hdl)) {
1379 m_response.set_status(http::status_code::switching_protocols);
1380
1381 // Write the appropriate response headers based on request and
1382 // processor version
1383 ec = m_processor->process_handshake(m_request,m_subprotocol,m_response);
1384
1385 if (ec) {
1386 std::stringstream s;
1387 s << "Processing error: " << ec << "(" << ec.message() << ")";
1388 m_alog->write(log::alevel::devel, s.str());
1389
1390 m_response.set_status(http::status_code::internal_server_error);
1391 return ec;
1392 }
1393 } else {
1394 // User application has rejected the handshake
1395 m_alog->write(log::alevel::devel, "USER REJECT");
1396
1397 // Use Bad Request if the user handler did not provide a more
1398 // specific http response error code.
1399 // TODO: is there a better default?
1400 if (m_response.get_status_code() == http::status_code::uninitialized) {
1401 m_response.set_status(http::status_code::bad_request);
1402 }
1403
1404 return error::make_error_code(error::rejected);
1405 }
1406
1407 return lib::error_code();
1408}
1409
1410template <typename config>
1411void connection<config>::write_http_response(lib::error_code const & ec) {
1412 m_alog->write(log::alevel::devel,"connection write_http_response");
1413
1414 if (ec == error::make_error_code(error::http_connection_ended)) {
1415 m_alog->write(log::alevel::http,"An HTTP handler took over the connection.");
1416 return;
1417 }
1418
1419 if (m_response.get_status_code() == http::status_code::uninitialized) {
1420 lib::error_code status_ec;
1421 m_response.set_status(http::status_code::internal_server_error);
1422 m_ec = error::make_error_code(error::general);
1423 } else {
1424 m_ec = ec;
1425 }
1426
1427 m_response.set_version("HTTP/1.1");
1428
1429 // Set server header based on the user agent settings
1430 if (m_response.get_header("Server").empty()) {
1431 if (!m_user_agent.empty()) {
1432 m_response.replace_header("Server",m_user_agent);
1433 } else {
1434 m_response.remove_header("Server");
1435 }
1436 }
1437
1438 // have the processor generate the raw bytes for the wire (if it exists)
1439 if (m_processor) {
1440 m_handshake_buffer = m_processor->get_raw(m_response);
1441 } else {
1442 // a processor wont exist for raw HTTP responses.
1443 m_handshake_buffer = m_response.raw();
1444 }
1445
1446 if (m_alog->static_test(log::alevel::devel)) {
1447 m_alog->write(log::alevel::devel,"Raw Handshake response:\n"+m_handshake_buffer);
1448 if (!m_response.get_header("Sec-WebSocket-Key3").empty()) {
1449 m_alog->write(log::alevel::devel,
1450 utility::to_hex(m_response.get_header("Sec-WebSocket-Key3")));
1451 }
1452 }
1453
1454 // write raw bytes
1455 transport_con_type::async_write(
1456 m_handshake_buffer.data(),
1457 m_handshake_buffer.size(),
1458 lib::bind(
1459 &type::handle_write_http_response,
1461 lib::placeholders::_1
1462 )
1463 );
1464}
1465
1466template <typename config>
1467void connection<config>::handle_write_http_response(lib::error_code const & ec) {
1468 m_alog->write(log::alevel::devel,"handle_write_http_response");
1469
1470 lib::error_code ecm = ec;
1471
1472 if (!ecm) {
1473 scoped_lock_type lock(m_connection_state_lock);
1474
1475 if (m_state == session::state::connecting) {
1476 if (m_internal_state != istate::PROCESS_HTTP_REQUEST) {
1477 ecm = error::make_error_code(error::invalid_state);
1478 }
1479 } else if (m_state == session::state::closed) {
1480 // The connection was canceled while the response was being sent,
1481 // usually by the handshake timer. This is basically expected
1482 // (though hopefully rare) and there is nothing we can do so ignore.
1483 m_alog->write(log::alevel::devel,
1484 "handle_write_http_response invoked after connection was closed");
1485 return;
1486 } else {
1487 ecm = error::make_error_code(error::invalid_state);
1488 }
1489 }
1490
1491 if (ecm) {
1492 if (ecm == transport::error::eof && m_state == session::state::closed) {
1493 // we expect to get eof if the connection is closed already
1494 m_alog->write(log::alevel::devel,
1495 "got (expected) eof/state error from closed con");
1496 return;
1497 }
1498
1499 log_err(log::elevel::rerror,"handle_write_http_response",ecm);
1500 this->terminate(ecm);
1501 return;
1502 }
1503
1504 if (m_handshake_timer) {
1505 m_handshake_timer->cancel();
1506 m_handshake_timer.reset();
1507 }
1508
1509 if (m_response.get_status_code() != http::status_code::switching_protocols)
1510 {
1511 /*if (m_processor || m_ec == error::http_parse_error ||
1512 m_ec == error::invalid_version || m_ec == error::unsupported_version
1513 || m_ec == error::upgrade_required)
1514 {*/
1515 if (!m_is_http) {
1516 std::stringstream s;
1517 s << "Handshake ended with HTTP error: "
1518 << m_response.get_status_code();
1519 m_elog->write(log::elevel::rerror,s.str());
1520 } else {
1521 // if this was not a websocket connection, we have written
1522 // the expected response and the connection can be closed.
1523
1524 this->log_http_result();
1525
1526 if (m_ec) {
1527 m_alog->write(log::alevel::devel,
1528 "got to writing HTTP results with m_ec set: "+m_ec.message());
1529 }
1530 m_ec = make_error_code(error::http_connection_ended);
1531 }
1532
1533 this->terminate(m_ec);
1534 return;
1535 }
1536
1537 this->log_open_result();
1538
1539 m_internal_state = istate::PROCESS_CONNECTION;
1540 m_state = session::state::open;
1541
1542 if (m_open_handler) {
1543 m_open_handler(m_connection_hdl);
1544 }
1545
1546 this->handle_read_frame(lib::error_code(), m_buf_cursor);
1547}
1548
1549template <typename config>
1550void connection<config>::send_http_request() {
1551 m_alog->write(log::alevel::devel,"connection send_http_request");
1552
1553 // TODO: origin header?
1554
1555 // Have the protocol processor fill in the appropriate fields based on the
1556 // selected client version
1557 if (m_processor) {
1558 lib::error_code ec;
1559 ec = m_processor->client_handshake_request(m_request,m_uri,
1560 m_requested_subprotocols);
1561
1562 if (ec) {
1563 log_err(log::elevel::fatal,"Internal library error: Processor",ec);
1564 return;
1565 }
1566 } else {
1567 m_elog->write(log::elevel::fatal,"Internal library error: missing processor");
1568 return;
1569 }
1570
1571 // Unless the user has overridden the user agent, send generic WS++ UA.
1572 if (m_request.get_header("User-Agent").empty()) {
1573 if (!m_user_agent.empty()) {
1574 m_request.replace_header("User-Agent",m_user_agent);
1575 } else {
1576 m_request.remove_header("User-Agent");
1577 }
1578 }
1579
1580 m_handshake_buffer = m_request.raw();
1581
1582 if (m_alog->static_test(log::alevel::devel)) {
1583 m_alog->write(log::alevel::devel,"Raw Handshake request:\n"+m_handshake_buffer);
1584 }
1585
1586 if (m_open_handshake_timeout_dur > 0) {
1587 m_handshake_timer = transport_con_type::set_timer(
1588 m_open_handshake_timeout_dur,
1589 lib::bind(
1590 &type::handle_open_handshake_timeout,
1592 lib::placeholders::_1
1593 )
1594 );
1595 }
1596
1597 transport_con_type::async_write(
1598 m_handshake_buffer.data(),
1599 m_handshake_buffer.size(),
1600 lib::bind(
1601 &type::handle_send_http_request,
1603 lib::placeholders::_1
1604 )
1605 );
1606}
1607
1608template <typename config>
1609void connection<config>::handle_send_http_request(lib::error_code const & ec) {
1610 m_alog->write(log::alevel::devel,"handle_send_http_request");
1611
1612 lib::error_code ecm = ec;
1613
1614 if (!ecm) {
1615 scoped_lock_type lock(m_connection_state_lock);
1616
1617 if (m_state == session::state::connecting) {
1618 if (m_internal_state != istate::WRITE_HTTP_REQUEST) {
1619 ecm = error::make_error_code(error::invalid_state);
1620 } else {
1621 m_internal_state = istate::READ_HTTP_RESPONSE;
1622 }
1623 } else if (m_state == session::state::closed) {
1624 // The connection was canceled while the response was being sent,
1625 // usually by the handshake timer. This is basically expected
1626 // (though hopefully rare) and there is nothing we can do so ignore.
1627 m_alog->write(log::alevel::devel,
1628 "handle_send_http_request invoked after connection was closed");
1629 return;
1630 } else {
1631 ecm = error::make_error_code(error::invalid_state);
1632 }
1633 }
1634
1635 if (ecm) {
1636 if (ecm == transport::error::eof && m_state == session::state::closed) {
1637 // we expect to get eof if the connection is closed already
1638 m_alog->write(log::alevel::devel,
1639 "got (expected) eof/state error from closed con");
1640 return;
1641 }
1642
1643 log_err(log::elevel::rerror,"handle_send_http_request",ecm);
1644 this->terminate(ecm);
1645 return;
1646 }
1647
1648 transport_con_type::async_read_at_least(
1649 1,
1650 m_buf,
1651 config::connection_read_buffer_size,
1652 lib::bind(
1653 &type::handle_read_http_response,
1655 lib::placeholders::_1,
1656 lib::placeholders::_2
1657 )
1658 );
1659}
1660
1661template <typename config>
1662void connection<config>::handle_read_http_response(lib::error_code const & ec,
1663 size_t bytes_transferred)
1664{
1665 m_alog->write(log::alevel::devel,"handle_read_http_response");
1666
1667 lib::error_code ecm = ec;
1668
1669 if (!ecm) {
1670 scoped_lock_type lock(m_connection_state_lock);
1671
1672 if (m_state == session::state::connecting) {
1673 if (m_internal_state != istate::READ_HTTP_RESPONSE) {
1674 ecm = error::make_error_code(error::invalid_state);
1675 }
1676 } else if (m_state == session::state::closed) {
1677 // The connection was canceled while the response was being sent,
1678 // usually by the handshake timer. This is basically expected
1679 // (though hopefully rare) and there is nothing we can do so ignore.
1680 m_alog->write(log::alevel::devel,
1681 "handle_read_http_response invoked after connection was closed");
1682 return;
1683 } else {
1684 ecm = error::make_error_code(error::invalid_state);
1685 }
1686 }
1687
1688 if (ecm) {
1689 if (ecm == transport::error::eof && m_state == session::state::closed) {
1690 // we expect to get eof if the connection is closed already
1691 m_alog->write(log::alevel::devel,
1692 "got (expected) eof/state error from closed con");
1693 return;
1694 }
1695
1696 log_err(log::elevel::rerror,"handle_read_http_response",ecm);
1697 this->terminate(ecm);
1698 return;
1699 }
1700
1701 size_t bytes_processed = 0;
1702
1703 lib::error_code consume_ec;
1704
1705 bytes_processed = m_response.consume(m_buf, bytes_transferred, consume_ec);
1706 if (consume_ec) {
1707 // An HTTP error while reading a response doesn't give us many options other than log
1708 // and terminate.
1709 m_response.set_status(http::error::get_status_code(http::error::value(consume_ec.value())));
1710 log_err(log::elevel::rerror,"error in handle_read_http_response: ",consume_ec);
1711 this->terminate(make_error_code(error::general));
1712 return;
1713 }
1714
1715 m_alog->write(log::alevel::devel,std::string("Raw response: ")+m_response.raw());
1716
1717 if (m_response.headers_ready()) {
1718 if (m_handshake_timer) {
1719 m_handshake_timer->cancel();
1720 m_handshake_timer.reset();
1721 }
1722
1723 lib::error_code validate_ec = m_processor->validate_server_handshake_response(
1724 m_request,
1725 m_response
1726 );
1727 if (validate_ec) {
1728 log_err(log::elevel::rerror,"Server handshake response",validate_ec);
1729 this->terminate(validate_ec);
1730 return;
1731 }
1732
1733 // Read extension parameters and set up values necessary for the end
1734 // user to complete extension negotiation.
1735 std::pair<lib::error_code,std::string> neg_results;
1736 neg_results = m_processor->negotiate_extensions(m_response);
1737
1738 if (neg_results.first) {
1739 // There was a fatal error in extension negotiation. For the moment
1740 // kill all connections that fail extension negotiation.
1741
1742 // TODO: deal with cases where the response is well formed but
1743 // doesn't match the options requested by the client. Its possible
1744 // that the best behavior in this cases is to log and continue with
1745 // an unextended connection.
1746 m_alog->write(log::alevel::devel, "Extension negotiation failed: "
1747 + neg_results.first.message());
1748 this->terminate(make_error_code(error::extension_neg_failed));
1749 // TODO: close connection with reason 1010 (and list extensions)
1750 }
1751
1752 // response is valid, connection can now be assumed to be open
1753 m_internal_state = istate::PROCESS_CONNECTION;
1754 m_state = session::state::open;
1755
1756 this->log_open_result();
1757
1758 if (m_open_handler) {
1759 m_open_handler(m_connection_hdl);
1760 }
1761
1762 // The remaining bytes in m_buf are frame data. Copy them to the
1763 // beginning of the buffer and note the length. They will be read after
1764 // the handshake completes and before more bytes are read.
1765 std::copy(m_buf+bytes_processed,m_buf+bytes_transferred,m_buf);
1766 m_buf_cursor = bytes_transferred-bytes_processed;
1767
1768 this->handle_read_frame(lib::error_code(), m_buf_cursor);
1769 } else {
1770 // The HTTP parser reported that it was not ready and wants more data.
1771 // Assert that it actually consumed all the data present before overwriting
1772 // the buffer. This should always be the case.
1773 if (bytes_transferred != bytes_processed) {
1774 m_elog->write(log::elevel::fatal,"Assertion Failed: HTTP response parser failed to consume all bytes from a read request.");
1775 this->terminate(make_error_code(error::general));
1776 return;
1777 }
1778
1779 transport_con_type::async_read_at_least(
1780 1,
1781 m_buf,
1782 config::connection_read_buffer_size,
1783 lib::bind(
1784 &type::handle_read_http_response,
1786 lib::placeholders::_1,
1787 lib::placeholders::_2
1788 )
1789 );
1790 }
1791}
1792
1793template <typename config>
1794void connection<config>::handle_open_handshake_timeout(
1795 lib::error_code const & ec)
1796{
1798 m_alog->write(log::alevel::devel,"open handshake timer cancelled");
1799 } else if (ec) {
1800 m_alog->write(log::alevel::devel,
1801 "open handle_open_handshake_timeout error: "+ec.message());
1802 // TODO: ignore or fail here?
1803 } else {
1804 m_alog->write(log::alevel::devel,"open handshake timer expired");
1805 terminate(make_error_code(error::open_handshake_timeout));
1806 }
1807}
1808
1809template <typename config>
1810void connection<config>::handle_close_handshake_timeout(
1811 lib::error_code const & ec)
1812{
1814 m_alog->write(log::alevel::devel,"asio close handshake timer cancelled");
1815 } else if (ec) {
1816 m_alog->write(log::alevel::devel,
1817 "asio open handle_close_handshake_timeout error: "+ec.message());
1818 // TODO: ignore or fail here?
1819 } else {
1820 m_alog->write(log::alevel::devel, "asio close handshake timer expired");
1821 terminate(make_error_code(error::close_handshake_timeout));
1822 }
1823}
1824
1825template <typename config>
1826void connection<config>::terminate(lib::error_code const & ec) {
1827 if (m_alog->static_test(log::alevel::devel)) {
1828 m_alog->write(log::alevel::devel,"connection terminate");
1829 }
1830
1831 // Cancel close handshake timer
1832 if (m_handshake_timer) {
1833 m_handshake_timer->cancel();
1834 m_handshake_timer.reset();
1835 }
1836
1837 // Cancel ping timer
1838 if (m_ping_timer) {
1839 m_ping_timer->cancel();
1840 m_handshake_timer.reset();
1841 }
1842
1843 terminate_status tstat = unknown;
1844 if (ec) {
1845 m_ec = ec;
1846 m_local_close_code = close::status::abnormal_close;
1847 m_local_close_reason = ec.message();
1848 }
1849
1850 // TODO: does any of this need a mutex?
1851 if (m_is_http) {
1852 m_http_state = session::http_state::closed;
1853 }
1854 if (m_state == session::state::connecting) {
1855 m_state = session::state::closed;
1856 tstat = failed;
1857
1858 // Log fail result here before socket is shut down and we can't get
1859 // the remote address, etc anymore
1860 if (m_ec != error::http_connection_ended) {
1861 log_fail_result();
1862 }
1863 } else if (m_state != session::state::closed) {
1864 m_state = session::state::closed;
1865 tstat = closed;
1866 } else {
1867 m_alog->write(log::alevel::devel,
1868 "terminate called on connection that was already terminated");
1869 return;
1870 }
1871
1872 // TODO: choose between shutdown and close based on error code sent
1873
1874 transport_con_type::async_shutdown(
1875 lib::bind(
1876 &type::handle_terminate,
1878 tstat,
1879 lib::placeholders::_1
1880 )
1881 );
1882}
1883
1884template <typename config>
1885void connection<config>::handle_terminate(terminate_status tstat,
1886 lib::error_code const & ec)
1887{
1888 if (m_alog->static_test(log::alevel::devel)) {
1889 m_alog->write(log::alevel::devel,"connection handle_terminate");
1890 }
1891
1892 if (ec) {
1893 // there was an error actually shutting down the connection
1894 log_err(log::elevel::devel,"handle_terminate",ec);
1895 }
1896
1897 // clean shutdown
1898 if (tstat == failed) {
1899 if (m_ec != error::http_connection_ended) {
1900 if (m_fail_handler) {
1901 m_fail_handler(m_connection_hdl);
1902 }
1903 }
1904 } else if (tstat == closed) {
1905 if (m_close_handler) {
1906 m_close_handler(m_connection_hdl);
1907 }
1908 log_close_result();
1909 } else {
1910 m_elog->write(log::elevel::rerror,"Unknown terminate_status");
1911 }
1912
1913 // call the termination handler if it exists
1914 // if it exists it might (but shouldn't) refer to a bad memory location.
1915 // If it does, we don't care and should catch and ignore it.
1916 // todo: there has to be a better way to do this.
1917 if (m_termination_handler) {
1918#ifndef _WEBSOCKETPP_NO_EXCEPTIONS_
1919 try {
1920 m_termination_handler(type::get_shared());
1921 } catch (std::exception const & e) {
1922 m_elog->write(log::elevel::warn,
1923 std::string("termination_handler call failed. Reason was: ")+e.what());
1924 }
1925#else
1926 m_termination_handler(type::get_shared());
1927#endif
1928 }
1929}
1930
1931template <typename config>
1932void connection<config>::write_frame() {
1933 //m_alog->write(log::alevel::devel,"connection write_frame");
1934
1935 {
1936 scoped_lock_type lock(m_write_lock);
1937
1938 // Check the write flag. If true, there is an outstanding transport
1939 // write already. In this case we just return. The write handler will
1940 // start a new write if the write queue isn't empty. If false, we set
1941 // the write flag and proceed to initiate a transport write.
1942 if (m_write_flag) {
1943 return;
1944 }
1945
1946 // pull off all the messages that are ready to write.
1947 // stop if we get a message marked terminal
1948 message_ptr next_message = write_pop();
1949 while (next_message) {
1950 m_current_msgs.push_back(next_message);
1951 if (!next_message->get_terminal()) {
1952 next_message = write_pop();
1953 } else {
1954 next_message = message_ptr();
1955 }
1956 }
1957
1958 if (m_current_msgs.empty()) {
1959 // there was nothing to send
1960 return;
1961 } else {
1962 // At this point we own the next messages to be sent and are
1963 // responsible for holding the write flag until they are
1964 // successfully sent or there is some error
1965 m_write_flag = true;
1966 }
1967 }
1968
1969 typename std::vector<message_ptr>::iterator it;
1970 for (it = m_current_msgs.begin(); it != m_current_msgs.end(); ++it) {
1971 std::string const & header = (*it)->get_header();
1972 std::string const & payload = (*it)->get_payload();
1973
1974 m_send_buffer.push_back(transport::buffer(header.c_str(),header.size()));
1975 m_send_buffer.push_back(transport::buffer(payload.c_str(),payload.size()));
1976 }
1977
1978 // Print detailed send stats if those log levels are enabled
1979 if (m_alog->static_test(log::alevel::frame_header)) {
1980 if (m_alog->dynamic_test(log::alevel::frame_header)) {
1981 std::stringstream general,header,payload;
1982
1983 general << "Dispatching write containing " << m_current_msgs.size()
1984 <<" message(s) containing ";
1985 header << "Header Bytes: \n";
1986 payload << "Payload Bytes: \n";
1987
1988 size_t hbytes = 0;
1989 size_t pbytes = 0;
1990
1991 for (size_t i = 0; i < m_current_msgs.size(); i++) {
1992 hbytes += m_current_msgs[i]->get_header().size();
1993 pbytes += m_current_msgs[i]->get_payload().size();
1994
1995
1996 header << "[" << i << "] ("
1997 << m_current_msgs[i]->get_header().size() << ") "
1998 << utility::to_hex(m_current_msgs[i]->get_header()) << "\n";
1999
2000 if (m_alog->static_test(log::alevel::frame_payload)) {
2001 if (m_alog->dynamic_test(log::alevel::frame_payload)) {
2002 payload << "[" << i << "] ("
2003 << m_current_msgs[i]->get_payload().size() << ") ["<<m_current_msgs[i]->get_opcode()<<"] "
2004 << (m_current_msgs[i]->get_opcode() == frame::opcode::text ?
2005 m_current_msgs[i]->get_payload() :
2006 utility::to_hex(m_current_msgs[i]->get_payload())
2007 )
2008 << "\n";
2009 }
2010 }
2011 }
2012
2013 general << hbytes << " header bytes and " << pbytes << " payload bytes";
2014
2015 m_alog->write(log::alevel::frame_header,general.str());
2016 m_alog->write(log::alevel::frame_header,header.str());
2017 m_alog->write(log::alevel::frame_payload,payload.str());
2018 }
2019 }
2020
2021 transport_con_type::async_write(
2022 m_send_buffer,
2023 m_write_frame_handler
2024 );
2025}
2026
2027template <typename config>
2028void connection<config>::handle_write_frame(lib::error_code const & ec)
2029{
2030 if (m_alog->static_test(log::alevel::devel)) {
2031 m_alog->write(log::alevel::devel,"connection handle_write_frame");
2032 }
2033
2034 bool terminal = m_current_msgs.back()->get_terminal();
2035
2036 m_send_buffer.clear();
2037 m_current_msgs.clear();
2038 // TODO: recycle instead of deleting
2039
2040 if (ec) {
2041 log_err(log::elevel::fatal,"handle_write_frame",ec);
2042 this->terminate(ec);
2043 return;
2044 }
2045
2046 if (terminal) {
2047 this->terminate(lib::error_code());
2048 return;
2049 }
2050
2051 bool needs_writing = false;
2052 {
2053 scoped_lock_type lock(m_write_lock);
2054
2055 // release write flag
2056 m_write_flag = false;
2057
2058 needs_writing = !m_send_queue.empty();
2059 }
2060
2061 if (needs_writing) {
2062 transport_con_type::dispatch(lib::bind(
2065 ));
2066 }
2067}
2068
2069template <typename config>
2070std::vector<int> const & connection<config>::get_supported_versions() const
2071{
2072 return versions_supported;
2073}
2074
2075template <typename config>
2076void connection<config>::process_control_frame(typename config::message_type::ptr msg)
2077{
2078 m_alog->write(log::alevel::devel,"process_control_frame");
2079
2080 frame::opcode::value op = msg->get_opcode();
2081 lib::error_code ec;
2082
2083 std::stringstream s;
2084 s << "Control frame received with opcode " << op;
2085 m_alog->write(log::alevel::control,s.str());
2086
2087 if (m_state == session::state::closed) {
2088 m_elog->write(log::elevel::warn,"got frame in state closed");
2089 return;
2090 }
2091 if (op != frame::opcode::CLOSE && m_state != session::state::open) {
2092 m_elog->write(log::elevel::warn,"got non-close frame in state closing");
2093 return;
2094 }
2095
2096 if (op == frame::opcode::PING) {
2097 bool should_reply = true;
2098
2099 if (m_ping_handler) {
2100 should_reply = m_ping_handler(m_connection_hdl, msg->get_payload());
2101 }
2102
2103 if (should_reply) {
2104 this->pong(msg->get_payload(),ec);
2105 if (ec) {
2106 log_err(log::elevel::devel,"Failed to send response pong",ec);
2107 }
2108 }
2109 } else if (op == frame::opcode::PONG) {
2110 if (m_ping_timer) {
2111 m_ping_timer->cancel();
2112 }
2113 if (m_pong_handler) {
2114 m_pong_handler(m_connection_hdl, msg->get_payload());
2115 }
2116 } else if (op == frame::opcode::CLOSE) {
2117 m_alog->write(log::alevel::devel,"got close frame");
2118 // record close code and reason somewhere
2119
2120 m_remote_close_code = close::extract_code(msg->get_payload(),ec);
2121 if (ec) {
2122 s.str("");
2123 if (config::drop_on_protocol_error) {
2124 s << "Received invalid close code " << m_remote_close_code
2125 << " dropping connection per config.";
2126 m_elog->write(log::elevel::devel,s.str());
2127 this->terminate(ec);
2128 } else {
2129 s << "Received invalid close code " << m_remote_close_code
2130 << " sending acknowledgement and closing";
2131 m_elog->write(log::elevel::devel,s.str());
2132 ec = send_close_ack(close::status::protocol_error,
2133 "Invalid close code");
2134 if (ec) {
2135 log_err(log::elevel::devel,"send_close_ack",ec);
2136 }
2137 }
2138 return;
2139 }
2140
2141 m_remote_close_reason = close::extract_reason(msg->get_payload(),ec);
2142 if (ec) {
2143 if (config::drop_on_protocol_error) {
2144 m_elog->write(log::elevel::devel,
2145 "Received invalid close reason. Dropping connection per config");
2146 this->terminate(ec);
2147 } else {
2148 m_elog->write(log::elevel::devel,
2149 "Received invalid close reason. Sending acknowledgement and closing");
2150 ec = send_close_ack(close::status::protocol_error,
2151 "Invalid close reason");
2152 if (ec) {
2153 log_err(log::elevel::devel,"send_close_ack",ec);
2154 }
2155 }
2156 return;
2157 }
2158
2159 if (m_state == session::state::open) {
2160 s.str("");
2161 s << "Received close frame with code " << m_remote_close_code
2162 << " and reason " << m_remote_close_reason;
2163 m_alog->write(log::alevel::devel,s.str());
2164
2165 ec = send_close_ack();
2166 if (ec) {
2167 log_err(log::elevel::devel,"send_close_ack",ec);
2168 }
2169 } else if (m_state == session::state::closing && !m_was_clean) {
2170 // ack of our close
2171 m_alog->write(log::alevel::devel, "Got acknowledgement of close");
2172
2173 m_was_clean = true;
2174
2175 // If we are a server terminate the connection now. Clients should
2176 // leave the connection open to give the server an opportunity to
2177 // initiate the TCP close. The client's timer will handle closing
2178 // its side of the connection if the server misbehaves.
2179 //
2180 // TODO: different behavior if the underlying transport doesn't
2181 // support timers?
2182 if (m_is_server) {
2183 terminate(lib::error_code());
2184 }
2185 } else {
2186 // spurious, ignore
2187 m_elog->write(log::elevel::devel, "Got close frame in wrong state");
2188 }
2189 } else {
2190 // got an invalid control opcode
2191 m_elog->write(log::elevel::devel, "Got control frame with invalid opcode");
2192 // initiate protocol error shutdown
2193 }
2194}
2195
2196template <typename config>
2197lib::error_code connection<config>::send_close_ack(close::status::value code,
2198 std::string const & reason)
2199{
2200 return send_close_frame(code,reason,true,m_is_server);
2201}
2202
2203template <typename config>
2204lib::error_code connection<config>::send_close_frame(close::status::value code,
2205 std::string const & reason, bool ack, bool terminal)
2206{
2207 m_alog->write(log::alevel::devel,"send_close_frame");
2208
2209 // check for special codes
2210
2211 // If silent close is set, respect it and blank out close information
2212 // Otherwise use whatever has been specified in the parameters. If
2213 // parameters specifies close::status::blank then determine what to do
2214 // based on whether or not this is an ack. If it is not an ack just
2215 // send blank info. If it is an ack then echo the close information from
2216 // the remote endpoint.
2217 if (config::silent_close) {
2218 m_alog->write(log::alevel::devel,"closing silently");
2219 m_local_close_code = close::status::no_status;
2220 m_local_close_reason.clear();
2221 } else if (code != close::status::blank) {
2222 m_alog->write(log::alevel::devel,"closing with specified codes");
2223 m_local_close_code = code;
2224 m_local_close_reason = reason;
2225 } else if (!ack) {
2226 m_alog->write(log::alevel::devel,"closing with no status code");
2227 m_local_close_code = close::status::no_status;
2228 m_local_close_reason.clear();
2229 } else if (m_remote_close_code == close::status::no_status) {
2230 m_alog->write(log::alevel::devel,
2231 "acknowledging a no-status close with normal code");
2232 m_local_close_code = close::status::normal;
2233 m_local_close_reason.clear();
2234 } else {
2235 m_alog->write(log::alevel::devel,"acknowledging with remote codes");
2236 m_local_close_code = m_remote_close_code;
2237 m_local_close_reason = m_remote_close_reason;
2238 }
2239
2240 std::stringstream s;
2241 s << "Closing with code: " << m_local_close_code << ", and reason: "
2242 << m_local_close_reason;
2243 m_alog->write(log::alevel::devel,s.str());
2244
2245 message_ptr msg = m_msg_manager->get_message();
2246 if (!msg) {
2247 return error::make_error_code(error::no_outgoing_buffers);
2248 }
2249
2250 lib::error_code ec = m_processor->prepare_close(m_local_close_code,
2251 m_local_close_reason,msg);
2252 if (ec) {
2253 return ec;
2254 }
2255
2256 // Messages flagged terminal will result in the TCP connection being dropped
2257 // after the message has been written. This is typically used when servers
2258 // send an ack and when any endpoint encounters a protocol error
2259 if (terminal) {
2260 msg->set_terminal(true);
2261 }
2262
2263 m_state = session::state::closing;
2264
2265 // Cancel any outstanding ping timers. Once we are in state closing the
2266 // library no longer processes non-close frames, so any pongs will be
2267 // dropped.
2268 if (m_ping_timer) {
2269 m_ping_timer->cancel();
2270 }
2271
2272 if (ack) {
2273 m_was_clean = true;
2274 }
2275
2276 // Start a timer so we don't wait forever for the acknowledgement close
2277 // frame
2278 if (m_close_handshake_timeout_dur > 0) {
2279 m_handshake_timer = transport_con_type::set_timer(
2280 m_close_handshake_timeout_dur,
2281 lib::bind(
2282 &type::handle_close_handshake_timeout,
2284 lib::placeholders::_1
2285 )
2286 );
2287 }
2288
2289 bool needs_writing = false;
2290 {
2291 scoped_lock_type lock(m_write_lock);
2292 write_push(msg);
2293 needs_writing = !m_write_flag && !m_send_queue.empty();
2294 }
2295
2296 if (needs_writing) {
2297 transport_con_type::dispatch(lib::bind(
2300 ));
2301 }
2302
2303 return lib::error_code();
2304}
2305
2306template <typename config>
2307typename connection<config>::processor_ptr
2308connection<config>::get_processor(int version) const {
2309 // TODO: allow disabling certain versions
2310
2311 processor_ptr p;
2312
2313 switch (version) {
2314 case 0:
2315 p = lib::make_shared<processor::hybi00<config> >(
2316 transport_con_type::is_secure(),
2317 m_is_server,
2318 m_msg_manager
2319 );
2320 break;
2321 case 7:
2322 p = lib::make_shared<processor::hybi07<config> >(
2323 transport_con_type::is_secure(),
2324 m_is_server,
2325 m_msg_manager,
2326 lib::ref(m_rng)
2327 );
2328 break;
2329 case 8:
2330 p = lib::make_shared<processor::hybi08<config> >(
2331 transport_con_type::is_secure(),
2332 m_is_server,
2333 m_msg_manager,
2334 lib::ref(m_rng)
2335 );
2336 break;
2337 case 13:
2338 p = lib::make_shared<processor::hybi13<config> >(
2339 transport_con_type::is_secure(),
2340 m_is_server,
2341 m_msg_manager,
2342 lib::ref(m_rng)
2343 );
2344 break;
2345 default:
2346 return p;
2347 }
2348
2349 // Settings not configured by the constructor
2350 p->set_max_message_size(m_max_message_size);
2351
2352 return p;
2353}
2354
2355template <typename config>
2356void connection<config>::write_push(typename config::message_type::ptr msg)
2357{
2358 if (!msg) {
2359 return;
2360 }
2361
2362 m_send_buffer_size += msg->get_payload().size();
2363 m_send_queue.push(msg);
2364
2365 if (m_alog->static_test(log::alevel::devel)) {
2366 std::stringstream s;
2367 s << "write_push: message count: " << m_send_queue.size()
2368 << " buffer size: " << m_send_buffer_size;
2369 m_alog->write(log::alevel::devel,s.str());
2370 }
2371}
2372
2373template <typename config>
2374typename config::message_type::ptr connection<config>::write_pop()
2375{
2376 message_ptr msg;
2377
2378 if (m_send_queue.empty()) {
2379 return msg;
2380 }
2381
2382 msg = m_send_queue.front();
2383
2384 m_send_buffer_size -= msg->get_payload().size();
2385 m_send_queue.pop();
2386
2387 if (m_alog->static_test(log::alevel::devel)) {
2388 std::stringstream s;
2389 s << "write_pop: message count: " << m_send_queue.size()
2390 << " buffer size: " << m_send_buffer_size;
2391 m_alog->write(log::alevel::devel,s.str());
2392 }
2393 return msg;
2394}
2395
2396template <typename config>
2397void connection<config>::log_open_result()
2398{
2399 std::stringstream s;
2400
2401 int version;
2402 if (!processor::is_websocket_handshake(m_request)) {
2403 version = -1;
2404 } else {
2405 version = processor::get_websocket_version(m_request);
2406 }
2407
2408 // Connection Type
2409 s << (version == -1 ? "HTTP" : "WebSocket") << " Connection ";
2410
2411 // Remote endpoint address
2412 s << transport_con_type::get_remote_endpoint() << " ";
2413
2414 // Version string if WebSocket
2415 if (version != -1) {
2416 s << "v" << version << " ";
2417 }
2418
2419 // User Agent
2420 std::string ua = m_request.get_header("User-Agent");
2421 if (ua.empty()) {
2422 s << "\"\" ";
2423 } else {
2424 // check if there are any quotes in the user agent
2425 s << "\"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
2426 }
2427
2428 // URI
2429 s << (m_uri ? m_uri->get_resource() : "NULL") << " ";
2430
2431 // Status code
2432 s << m_response.get_status_code();
2433
2434 m_alog->write(log::alevel::connect,s.str());
2435}
2436
2437template <typename config>
2438void connection<config>::log_close_result()
2439{
2440 std::stringstream s;
2441
2442 s << "Disconnect "
2443 << "close local:[" << m_local_close_code
2444 << (m_local_close_reason.empty() ? "" : ","+m_local_close_reason)
2445 << "] remote:[" << m_remote_close_code
2446 << (m_remote_close_reason.empty() ? "" : ","+m_remote_close_reason) << "]";
2447
2448 m_alog->write(log::alevel::disconnect,s.str());
2449}
2450
2451template <typename config>
2452void connection<config>::log_fail_result()
2453{
2454 std::stringstream s;
2455
2456 int version = processor::get_websocket_version(m_request);
2457
2458 // Connection Type
2459 s << "WebSocket Connection ";
2460
2461 // Remote endpoint address & WebSocket version
2462 s << transport_con_type::get_remote_endpoint();
2463 if (version < 0) {
2464 s << " -";
2465 } else {
2466 s << " v" << version;
2467 }
2468
2469 // User Agent
2470 std::string ua = m_request.get_header("User-Agent");
2471 if (ua.empty()) {
2472 s << " \"\" ";
2473 } else {
2474 // check if there are any quotes in the user agent
2475 s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
2476 }
2477
2478 // URI
2479 s << (m_uri ? m_uri->get_resource() : "-");
2480
2481 // HTTP Status code
2482 s << " " << m_response.get_status_code();
2483
2484 // WebSocket++ error code & reason
2485 s << " " << m_ec << " " << m_ec.message();
2486
2487 m_alog->write(log::alevel::fail,s.str());
2488}
2489
2490template <typename config>
2491void connection<config>::log_http_result() {
2492 std::stringstream s;
2493
2494 if (processor::is_websocket_handshake(m_request)) {
2495 m_alog->write(log::alevel::devel,"Call to log_http_result for WebSocket");
2496 return;
2497 }
2498
2499 // Connection Type
2500 s << (m_request.get_header("host").empty() ? "-" : m_request.get_header("host"))
2501 << " " << transport_con_type::get_remote_endpoint()
2502 << " \"" << m_request.get_method()
2503 << " " << (m_uri ? m_uri->get_resource() : "-")
2504 << " " << m_request.get_version() << "\" " << m_response.get_status_code()
2505 << " " << m_response.get_body().size();
2506
2507 // User Agent
2508 std::string ua = m_request.get_header("User-Agent");
2509 if (ua.empty()) {
2510 s << " \"\" ";
2511 } else {
2512 // check if there are any quotes in the user agent
2513 s << " \"" << utility::string_replace_all(ua,"\"","\\\"") << "\" ";
2514 }
2515
2516 m_alog->write(log::alevel::http,s.str());
2517}
2518
2519} // namespace websocketpp
2520
2521#endif // WEBSOCKETPP_CONNECTION_IMPL_HPP
#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.
Definition basic.hpp:37
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.
Definition endpoint.hpp:44
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
Definition endpoint.hpp:468
connection_ptr get_con_from_hdl(connection_hdl hdl, lib::error_code &ec)
Retrieves a connection_ptr from a connection_hdl (exception free).
Definition endpoint.hpp:644
config::concurrency_type concurrency_type
Type of the concurrency component of this endpoint.
Definition endpoint.hpp:53
config::alog_type alog_type
Type of access logger.
Definition endpoint.hpp:77
alog_type & get_alog()
Get reference to access logger.
Definition endpoint.hpp:263
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:67
std::string get_user_agent() const
Returns the user agent string that this endpoint will use.
Definition endpoint.hpp:171
void clear_access_channels(log::level channels)
Clear Access logging channels.
Definition endpoint.hpp:233
void resume_reading(connection_hdl hdl)
Resume reading of new data.
config::elog_type elog_type
Type of error logger.
Definition endpoint.hpp:75
elog_type & get_elog()
Get reference to error logger.
Definition endpoint.hpp:271
bool is_server() const
Returns whether or not this endpoint is a server.
Definition endpoint.hpp:207
~endpoint()
Destructor.
Definition endpoint.hpp:114
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
Definition endpoint.hpp:379
connection_type::message_ptr message_ptr
Type of message pointers that this endpoint uses.
Definition endpoint.hpp:72
void set_access_channels(log::level channels)
Set Access logging channel.
Definition endpoint.hpp:222
void set_max_message_size(size_t new_value)
Set default maximum message size.
Definition endpoint.hpp:434
size_t get_max_message_size() const
Get default maximum message size.
Definition endpoint.hpp:417
connection_ptr get_con_from_hdl(connection_hdl hdl)
Retrieves a connection_ptr from a connection_hdl (exception version).
Definition endpoint.hpp:655
connection connection_type
Type of the connections that this endpoint creates.
Definition endpoint.hpp:56
void set_error_channels(log::level channels)
Set Error logging channel.
Definition endpoint.hpp:244
config::transport_type transport_type
Type of the transport component of this endpoint.
Definition endpoint.hpp:51
void clear_error_channels(log::level channels)
Clear Error logging channels.
Definition endpoint.hpp:255
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.
Definition endpoint.hpp:58
transport_type::transport_con_type transport_con_type
Definition endpoint.hpp:64
concurrency_type::mutex_type mutex_type
Type of our concurrency policy's mutex object.
Definition endpoint.hpp:82
void interrupt(connection_hdl hdl, lib::error_code &ec)
void set_pong_timeout(long dur)
Set pong timeout.
Definition endpoint.hpp:401
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
Definition endpoint.hpp:451
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
Definition endpoint.hpp:354
config::rng_type rng_type
Type of RNG.
Definition endpoint.hpp:85
concurrency_type::scoped_lock_type scoped_lock_type
Type of our concurrency policy's scoped lock object.
Definition endpoint.hpp:80
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.
Definition endpoint.hpp:70
connection_type::weak_ptr connection_weak_ptr
Weak pointer to connection type.
Definition endpoint.hpp:60
Stub class for use when disabling permessage_deflate extension.
Definition disabled.hpp:53
err_str_pair negotiate(http::attribute_list const &)
Negotiate extension.
Definition disabled.hpp:65
std::string generate_offer() const
Generate extension offer.
Definition disabled.hpp:99
lib::error_code init(bool)
Initialize state.
Definition disabled.hpp:76
HTTP parser error category.
An exception type specific to HTTP errors.
header_list const & get_headers() const
Return a list of all HTTP headers.
Definition parser.hpp:211
std::string const & get_body() const
Get HTTP body.
Definition parser.hpp:515
bool body_ready() const
Check if the parser is done parsing the body.
Definition parser.hpp:618
void set_max_body_size(size_t value)
Set body size limit.
Definition parser.hpp:555
bool prepare_body(lib::error_code &ec)
Prepare the parser to begin parsing body data.
Definition parser.hpp:143
std::string raw_headers() const
Generate and return the HTTP headers as a string.
Definition parser.hpp:215
size_t process_body(char const *buf, size_t len, lib::error_code &ec)
Process body data.
Definition parser.hpp:172
std::string const & get_version() const
Get the HTTP version string.
Definition parser.hpp:410
size_t get_max_body_size() const
Get body size limit.
Definition parser.hpp:542
lib::error_code process_header(std::string::iterator begin, std::string::iterator end)
Process a header line.
Definition parser.hpp:191
Stores, parses, and manipulates HTTP requests.
Definition request.hpp:50
std::string raw() const
Returns the full raw request (including the body).
Definition request.hpp:195
std::string const & get_uri() const
Return the requested URI.
Definition request.hpp:123
std::string const & get_method() const
Return the request method.
Definition request.hpp:107
bool ready() const
Returns whether or not the request is ready for reading.
Definition request.hpp:85
size_t consume(char const *buf, size_t len, lib::error_code &ec)
Process bytes in the input buffer.
Definition request.hpp:41
std::string raw_head() const
Returns the raw request headers only (similar to an HTTP HEAD request).
Definition request.hpp:205
Stores, parses, and manipulates HTTP responses.
Definition response.hpp:57
std::string raw() const
Returns the full raw response.
Definition response.hpp:246
size_t consume(char const *buf, size_t len, lib::error_code &ec)
Process bytes in the input buffer.
Definition response.hpp:42
bool headers_ready() const
Returns true if the response headers are fully parsed.
Definition response.hpp:149
size_t consume(std::istream &s, lib::error_code &ec)
Process bytes in the input buffer (istream version).
Definition response.hpp:189
lib::error_code set_status(status_code::value code)
Set response status code and message.
Definition response.hpp:259
bool ready() const
Returns true if the response is ready.
Definition response.hpp:144
const std::string & get_status_msg() const
Return the response status message.
Definition response.hpp:190
status_code::value get_status_code() const
Return the response status code.
Definition response.hpp:185
Basic logger that outputs to an ostream.
Definition basic.hpp:59
void write(level channel, char const *msg)
Write a cstring message to the given channel.
Definition basic.hpp:151
basic(basic< concurrency, names > const &other)
Copy constructor.
Definition basic.hpp:87
~basic()
Destructor.
Definition basic.hpp:84
bool recycle(message *)
Recycle a message.
Definition alloc.hpp:80
message_ptr get_message(frame::opcode::value op, size_t size)
Get a message buffer with specified size and opcode.
Definition alloc.hpp:66
message_ptr get_message()
Get an empty message buffer.
Definition alloc.hpp:55
con_msg_man_ptr get_manager() const
Get a pointer to a connection message manager.
Definition alloc.hpp:96
Represents a buffer for a single WebSocket message.
Definition message.hpp:84
message(const con_msg_man_ptr manager, frame::opcode::value op, size_t size=128)
Construct a message and fill in some values.
Definition message.hpp:107
std::string & get_raw_payload()
Get a non-const reference to the payload string.
Definition message.hpp:254
bool recycle()
Recycle the message.
Definition message.hpp:316
bool get_compressed() const
Return whether or not the message is flagged as compressed.
Definition message.hpp:143
bool get_terminal() const
Get whether or not the message is terminal.
Definition message.hpp:169
std::string const & get_header() const
Return the prepared frame header.
Definition message.hpp:224
void set_payload(void const *payload, size_t len)
Set payload data.
Definition message.hpp:275
bool get_fin() const
Read the fin bit.
Definition message.hpp:195
void append_payload(void const *payload, size_t len)
Append payload data.
Definition message.hpp:298
void set_opcode(frame::opcode::value op)
Set the opcode.
Definition message.hpp:215
void set_prepared(bool value)
Set or clear the flag that indicates that the message has been prepared.
Definition message.hpp:135
frame::opcode::value get_opcode() const
Return the message opcode.
Definition message.hpp:210
void set_terminal(bool value)
Set the terminal flag.
Definition message.hpp:181
bool get_prepared() const
Return whether or not the message has been prepared for sending.
Definition message.hpp:125
void set_compressed(bool value)
Set or clear the compression flag.
Definition message.hpp:156
message(const con_msg_man_ptr manager)
Construct an empty message.
Definition message.hpp:96
void set_fin(bool value)
Set the fin bit.
Definition message.hpp:205
std::string const & get_payload() const
Get a reference to the payload string.
Definition message.hpp:246
Category for processor errors.
Definition base.hpp:161
Processor for Hybi Draft version 00.
Definition hybi00.hpp:54
Processor for Hybi Draft version 07.
Definition hybi07.hpp:44
Processor for Hybi Draft version 08.
Definition hybi08.hpp:44
Processor for Hybi version 13 (RFC6455).
Definition hybi13.hpp:54
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 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.
Definition none.hpp:46
int_type operator()()
advances the engine's state and returns the generated value
Definition none.hpp:51
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.
Definition none.hpp:58
lib::asio::ip::tcp::socket & get_raw_socket()
Retrieve a pointer to the underlying socket.
Definition none.hpp:124
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection socket component.
Definition none.hpp:63
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
Definition none.hpp:100
connection type
Type of this connection socket component.
Definition none.hpp:61
lib::shared_ptr< lib::asio::io_context::strand > strand_ptr
Type of a pointer to the Asio io_context strand being used.
Definition none.hpp:68
lib::asio::ip::tcp::socket & get_socket()
Retrieve a pointer to the underlying socket.
Definition none.hpp:108
bool is_secure() const
Check whether or not this connection is secure.
Definition none.hpp:88
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the socket being used.
Definition none.hpp:72
static lib::error_code translate_ec(lib::error_code ec)
Definition none.hpp:293
static lib::error_code translate_ec(ErrorCodeType)
Translate any security policy specific information about an error code.
Definition none.hpp:285
void set_handle(connection_hdl hdl)
Sets the connection handle.
Definition none.hpp:235
lib::asio::error_code cancel_socket()
Cancel all async operations on this socket.
Definition none.hpp:248
void pre_init(init_handler callback)
Pre-initialize security policy.
Definition none.hpp:201
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
Definition none.hpp:138
lib::asio::io_context * io_context_ptr
Type of a pointer to the Asio io_context being used.
Definition none.hpp:66
void post_init(init_handler callback)
Post-initialize security policy.
Definition none.hpp:224
lib::asio::ip::tcp::socket socket_type
Type of the ASIO socket being used.
Definition none.hpp:70
lib::error_code init_asio(io_context_ptr context, strand_ptr, bool)
Perform one time initializations.
Definition none.hpp:166
ptr get_shared()
Get a shared pointer to this component.
Definition none.hpp:80
lib::asio::ip::tcp::socket & get_next_layer()
Retrieve a pointer to the underlying socket.
Definition none.hpp:116
Basic ASIO endpoint socket component.
Definition none.hpp:318
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
Definition none.hpp:347
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
Definition none.hpp:360
endpoint type
The type of this endpoint socket component.
Definition none.hpp:321
bool is_secure() const
Checks whether the endpoint creates secure connections.
Definition none.hpp:335
connection socket_con_type
The type of the corresponding connection socket component.
Definition none.hpp:324
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.
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.
Definition endpoint.hpp:54
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.
Definition endpoint.hpp:89
std::size_t run_one()
wraps the run_one method of the internal io_context object
Definition endpoint.hpp:671
socket_type::socket_con_type socket_con_type
Type of the socket connection component.
Definition endpoint.hpp:69
void stop_listening(lib::error_code &ec)
Stop listening (exception free).
Definition endpoint.hpp:546
config::socket_type socket_type
Type of the socket policy.
Definition endpoint.hpp:62
lib::shared_ptr< lib::asio::steady_timer > timer_ptr
Type of timer handle.
Definition endpoint.hpp:87
void async_connect(transport_con_ptr tcon, uri_ptr u, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:874
void init_asio()
Initialize asio transport with internal io_context.
Definition endpoint.hpp:252
config::elog_type elog_type
Type of the error logging policy.
Definition endpoint.hpp:64
void init_logging(const lib::shared_ptr< alog_type > &a, const lib::shared_ptr< elog_type > &e)
Initialize logging.
Definition endpoint.hpp:848
lib::asio::io_context * io_context_ptr
Type of a pointer to the ASIO io_context being used.
Definition endpoint.hpp:81
bool is_secure() const
Return whether or not the endpoint produces secure connections.
Definition endpoint.hpp:172
lib::asio::ip::tcp::endpoint get_local_endpoint(lib::asio::error_code &ec)
Get local TCP endpoint.
Definition endpoint.hpp:399
void set_reuse_addr(bool value)
Sets whether to use the SO_REUSEADDR flag when opening listening sockets.
Definition endpoint.hpp:367
void set_tcp_init_handler(tcp_init_handler h)
Sets the tcp pre init handler (deprecated).
Definition endpoint.hpp:306
void handle_timer(timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
Timer handler.
Definition endpoint.hpp:768
void start_perpetual()
Marks the endpoint as perpetual, stopping it from exiting when empty.
Definition endpoint.hpp:712
void stop()
wraps the stop method of the internal io_context object
Definition endpoint.hpp:676
std::size_t run()
wraps the run method of the internal io_context object
Definition endpoint.hpp:663
void set_tcp_post_init_handler(tcp_init_handler h)
Sets the tcp post init handler.
Definition endpoint.hpp:321
void set_listen_backlog(int backlog)
Sets the maximum length of the queue of pending connections.
Definition endpoint.hpp:346
bool stopped() const
wraps the stopped method of the internal io_context object
Definition endpoint.hpp:696
timer_ptr set_timer(long duration, timer_handler callback)
Call back a function after a period of time.
Definition endpoint.hpp:740
socket_con_type::ptr socket_con_ptr
Type of a shared pointer to the socket connection component.
Definition endpoint.hpp:71
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
asio::connection< config > transport_con_type
Definition endpoint.hpp:75
void init_asio(lib::error_code &ec)
Initialize asio transport with internal io_context (exception free).
Definition endpoint.hpp:229
void async_accept(transport_con_ptr tcon, accept_handler callback)
Accept the next connection attempt and assign it to con.
Definition endpoint.hpp:831
void listen(uint16_t port)
Set up endpoint for listening on a port.
Definition endpoint.hpp:607
endpoint< config > type
Type of this endpoint transport component.
Definition endpoint.hpp:57
void init_asio(io_context_ptr ptr, lib::error_code &ec)
initialize asio transport with external io_context (exception free)
Definition endpoint.hpp:185
config::concurrency_type concurrency_type
Type of the concurrency policy.
Definition endpoint.hpp:60
std::size_t poll()
wraps the poll method of the internal io_context object
Definition endpoint.hpp:681
void stop_perpetual()
Clears the endpoint's perpetual flag, allowing it to exit when empty.
Definition endpoint.hpp:724
void init_asio(io_context_ptr ptr)
initialize asio transport with external io_context
Definition endpoint.hpp:213
lib::shared_ptr< lib::asio::ip::tcp::acceptor > acceptor_ptr
Type of a shared pointer to the acceptor being used.
Definition endpoint.hpp:83
void listen(lib::asio::ip::tcp::endpoint const &ep)
Set up endpoint for listening manually.
Definition endpoint.hpp:569
lib::asio::io_context & get_io_context()
Retrieve a reference to the endpoint's io_context.
Definition endpoint.hpp:382
void handle_resolve_timeout(timer_ptr, connect_handler callback, lib::error_code const &ec)
DNS resolution timeout handler.
Definition endpoint.hpp:969
void listen(lib::asio::ip::tcp::endpoint const &ep, lib::error_code &ec)
Set up endpoint for listening manually (exception free).
Definition endpoint.hpp:416
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:78
void reset()
wraps the restart method of the internal io_context object
Definition endpoint.hpp:691
void set_tcp_pre_bind_handler(tcp_pre_bind_handler h)
Sets the tcp pre bind handler.
Definition endpoint.hpp:278
config::alog_type alog_type
Type of the access logging policy.
Definition endpoint.hpp:66
void listen(InternetProtocol const &internet_protocol, uint16_t port)
Set up endpoint for listening with protocol and port.
Definition endpoint.hpp:589
void set_tcp_pre_init_handler(tcp_init_handler h)
Sets the tcp pre init handler.
Definition endpoint.hpp:292
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).
Definition endpoint.hpp:791
std::size_t poll_one()
wraps the poll_one method of the internal io_context object
Definition endpoint.hpp:686
void listen(InternetProtocol const &internet_protocol, uint16_t port, lib::error_code &ec)
Set up endpoint for listening with protocol and port (exception free).
Definition endpoint.hpp:471
void listen(uint16_t port, lib::error_code &ec)
Set up endpoint for listening on a port (exception free).
Definition endpoint.hpp:490
bool is_listening() const
Check if the endpoint is listening.
Definition endpoint.hpp:658
void stop_listening()
Stop listening.
Definition endpoint.hpp:647
lib::shared_ptr< lib::asio::ip::tcp::resolver > resolver_ptr
Type of a shared pointer to the resolver being used.
Definition endpoint.hpp:85
lib::function< lib::error_code(acceptor_ptr)> tcp_pre_bind_handler
Type of socket pre-bind handler.
Definition endpoint.hpp:92
Asio transport error category.
Definition base.hpp:184
Error category related to asio transport socket policies.
Definition base.hpp:110
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 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
Definition endpoint.hpp:62
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition endpoint.hpp:56
void set_write_handler(write_handler h)
Sets the write handler.
Definition endpoint.hpp:134
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition endpoint.hpp:154
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition endpoint.hpp:116
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition endpoint.hpp:51
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:65
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:183
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition endpoint.hpp:197
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition endpoint.hpp:171
endpoint type
Type of this endpoint transport component.
Definition endpoint.hpp:49
void register_ostream(std::ostream *o)
Register a default output stream.
Definition endpoint.hpp:80
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition endpoint.hpp:54
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition endpoint.hpp:102
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition endpoint.hpp:58
iostream transport error category
Definition base.hpp:85
std::string get_query() const
Return the query portion.
Definition uri.hpp:732
bool is_ipv6_literal() const
Definition uri.hpp:651
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_
Definition cpp11.hpp:134
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition cpp11.hpp:115
#define __has_extension
Definition cpp11.hpp:40
#define __has_feature(x)
Definition cpp11.hpp:37
A package of types and methods for manipulating WebSocket close status'.
Definition close.hpp:47
static value const service_restart
Definition close.hpp:138
static value const message_too_big
An endpoint received a message too large to process.
Definition close.hpp:121
static value const try_again_later
Definition close.hpp:143
static value const force_tcp_drop
Close the connection with a forced TCP drop.
Definition close.hpp:72
static value const tls_handshake
An endpoint failed to perform a TLS handshake.
Definition close.hpp:157
static value const rsv_end
Last value in range reserved for future protocol use.
Definition close.hpp:177
static value const invalid_payload
An endpoint received message data inconsistent with its type.
Definition close.hpp:110
bool terminal(value code)
Determine if the code represents an unrecoverable error.
Definition close.hpp:217
static value const protocol_error
A protocol error occurred.
Definition close.hpp:83
std::string get_string(value code)
Return a human readable interpretation of a WebSocket close code.
Definition close.hpp:232
static value const bad_gateway
Definition close.hpp:148
static value const invalid_subprotocol_data
A invalid subprotocol data.
Definition close.hpp:172
static value const invalid_high
Last value in range that is always invalid on the wire.
Definition close.hpp:192
static value const unsupported_data
Definition close.hpp:91
static value const no_status
A dummy value to indicate that no status code was received.
Definition close.hpp:97
static value const omit_handshake
Close the connection without a WebSocket close handshake.
Definition close.hpp:62
static value const normal
Definition close.hpp:76
static value const blank
A blank value for internal use.
Definition close.hpp:52
static value const invalid_low
First value in range that is always invalid on the wire.
Definition close.hpp:190
static value const abnormal_close
A dummy value to indicate that the connection was closed abnormally.
Definition close.hpp:104
static value const rsv_start
First value in range reserved for future protocol use.
Definition close.hpp:175
uint16_t value
The type of a close code value.
Definition close.hpp:49
static value const policy_violation
An endpoint received a message that violated its policy.
Definition close.hpp:118
static value const extension_required
A client expected the server to accept a required extension request.
Definition close.hpp:129
bool invalid(value code)
Test whether a close code is invalid on the wire.
Definition close.hpp:199
static value const internal_endpoint_error
Definition close.hpp:133
static value const subprotocol_error
A generic subprotocol error.
Definition close.hpp:165
bool reserved(value code)
Test whether a close code is in a reserved range.
Definition close.hpp:184
static value const going_away
Definition close.hpp:80
A package of types and methods for manipulating WebSocket close codes.
Definition close.hpp:45
Concurrency handling support.
Definition basic.hpp:34
Library level error codes.
Definition error.hpp:44
@ general
Catch-all library error.
Definition error.hpp:47
@ unrequested_subprotocol
Selected subprotocol was not requested by the client.
Definition error.hpp:102
@ invalid_port
Invalid port in URI.
Definition error.hpp:120
@ client_only
Attempted to use a client specific feature on a server endpoint.
Definition error.hpp:105
@ http_connection_ended
HTTP connection ended.
Definition error.hpp:111
@ operation_canceled
The requested operation was canceled.
Definition error.hpp:127
@ no_outgoing_buffers
The endpoint is out of outgoing message buffers.
Definition error.hpp:68
@ http_parse_error
HTTP parse error.
Definition error.hpp:143
@ reserved_close_code
Close code is in a reserved range.
Definition error.hpp:80
@ con_creation_failed
Connection creation attempted failed.
Definition error.hpp:99
@ no_incoming_buffers
The endpoint is out of incoming message buffers.
Definition error.hpp:71
@ invalid_state
The connection was in the wrong state for this operation.
Definition error.hpp:74
@ extension_neg_failed
Extension negotiation failed.
Definition error.hpp:146
@ rejected
Connection rejected.
Definition error.hpp:130
@ unsupported_version
Unsupported WebSocket protocol version.
Definition error.hpp:140
@ invalid_utf8
Invalid UTF-8.
Definition error.hpp:86
@ invalid_close_code
Close code is invalid.
Definition error.hpp:83
@ server_only
Attempted to use a server specific feature on a client endpoint.
Definition error.hpp:108
@ endpoint_not_secure
Attempted to open a secure connection with an insecure endpoint.
Definition error.hpp:57
@ close_handshake_timeout
WebSocket close handshake timed out.
Definition error.hpp:117
@ invalid_subprotocol
Invalid subprotocol.
Definition error.hpp:89
@ bad_close_code
Unable to parse close code.
Definition error.hpp:77
@ open_handshake_timeout
WebSocket opening handshake timed out.
Definition error.hpp:114
@ invalid_version
Invalid WebSocket protocol version.
Definition error.hpp:137
@ transport_error
General transport error, consult more specific transport error code.
Definition error.hpp:149
@ send_queue_full
send attempted when endpoint write queue was full
Definition error.hpp:50
@ test
Unit testing utility error code.
Definition error.hpp:96
@ invalid_uri
An invalid uri was supplied.
Definition error.hpp:65
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition disabled.hpp:44
Constants related to frame and payload limits.
Definition frame.hpp:145
static uint8_t const close_reason_size
Maximum size of close frame reason.
Definition frame.hpp:169
static uint64_t const payload_size_jumbo
Maximum size of a jumbo WebSocket payload (basic payload = 127).
Definition frame.hpp:162
static unsigned int const max_extended_header_length
Maximum length of the variable portion of the WebSocket header.
Definition frame.hpp:153
static unsigned int const max_header_length
Maximum length of a WebSocket header.
Definition frame.hpp:150
static uint16_t const payload_size_extended
Maximum size of an extended WebSocket payload (basic payload = 126).
Definition frame.hpp:159
static uint8_t const payload_size_basic
Maximum size of a basic WebSocket payload.
Definition frame.hpp:156
static unsigned int const basic_header_length
Minimum length of a WebSocket frame header.
Definition frame.hpp:147
Constants and utility functions related to WebSocket opcodes.
Definition frame.hpp:76
bool invalid(value v)
Check if an opcode is invalid.
Definition frame.hpp:130
bool reserved(value v)
Check if an opcode is reserved.
Definition frame.hpp:118
bool is_control(value v)
Check if an opcode is for a control frame.
Definition frame.hpp:139
Data structures and utility functions for manipulating WebSocket frames.
Definition frame.hpp:45
unsigned int get_masking_key_offset(basic_header const &)
Calculate the offset location of the masking key within the extended header.
Definition frame.hpp:469
void set_rsv2(basic_header &h, bool value)
Set the frame's RSV2 bit.
Definition frame.hpp:366
static unsigned int const MAX_HEADER_LENGTH
Maximum length of a WebSocket header.
Definition frame.hpp:50
opcode::value get_opcode(basic_header const &h)
Extract opcode from basic header.
Definition frame.hpp:393
void set_rsv3(basic_header &h, bool value)
Set the frame's RSV3 bit.
Definition frame.hpp:384
uint64_t get_payload_size(basic_header const &, extended_header const &)
Extract the full payload size field from a WebSocket header.
Definition frame.hpp:573
uint8_t get_basic_size(basic_header const &)
Extracts the raw payload length specified in the basic header.
Definition frame.hpp:431
size_t byte_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask.
Definition frame.hpp:830
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.
Definition frame.hpp:645
static unsigned int const MAX_EXTENDED_HEADER_LENGTH
Maximum length of the variable portion of the WebSocket header.
Definition frame.hpp:52
bool get_rsv3(basic_header const &h)
check whether the frame's RSV3 bit is set
Definition frame.hpp:375
bool get_masked(basic_header const &h)
check whether the frame is masked
Definition frame.hpp:402
bool get_rsv2(basic_header const &h)
check whether the frame's RSV2 bit is set
Definition frame.hpp:357
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).
Definition frame.hpp:675
uint16_t get_extended_size(extended_header const &)
Extract the extended size field from an extended header.
Definition frame.hpp:540
size_t byte_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask (in place).
Definition frame.hpp:857
bool get_fin(basic_header const &h)
Check whether the frame's FIN bit is set.
Definition frame.hpp:321
size_t circshift_prepared_key(size_t prepared_key, size_t offset)
circularly shifts the supplied prepared masking key by offset bytes
Definition frame.hpp:612
bool get_rsv1(basic_header const &h)
check whether the frame's RSV1 bit is set
Definition frame.hpp:339
void set_masked(basic_header &h, bool value)
Set the frame's MASK bit.
Definition frame.hpp:411
size_t word_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular word aligned mask/unmask.
Definition frame.hpp:768
void word_mask_exact(uint8_t *data, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask (in place).
Definition frame.hpp:731
void set_rsv1(basic_header &h, bool value)
Set the frame's RSV1 bit.
Definition frame.hpp:348
size_t get_header_len(basic_header const &)
Calculates the full length of the header based on the first bytes.
Definition frame.hpp:445
void set_fin(basic_header &h, bool value)
Set the frame's FIN bit.
Definition frame.hpp:330
uint64_t get_jumbo_size(extended_header const &)
Extract the jumbo size field from an extended header.
Definition frame.hpp:555
void word_mask_exact(uint8_t *input, uint8_t *output, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask.
Definition frame.hpp:702
std::string prepare_header(const basic_header &h, const extended_header &e)
Generate a properly sized contiguous string that encodes a full frame header.
Definition frame.hpp:489
masking_key_type get_masking_key(basic_header const &, extended_header const &)
Extract the masking key from a frame header.
Definition frame.hpp:516
static unsigned int const BASIC_HEADER_LENGTH
Minimum length of a WebSocket frame header.
Definition frame.hpp:48
size_t word_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular word aligned mask/unmask (in place).
Definition frame.hpp:805
size_t prepare_masking_key(masking_key_type const &key)
Extract a masking key into a value the size of a machine word.
Definition frame.hpp:595
HTTP parser errors.
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.
HTTP handling support.
Definition request.hpp:37
size_t const max_body_size
Default Maximum size in bytes for HTTP message bodies.
Definition constants.hpp:71
static char const header_separator[]
Literal value of the HTTP header separator.
Definition constants.hpp:62
std::vector< std::pair< std::string, attribute_list > > parameter_list
The type of an HTTP parameter list.
Definition constants.hpp:56
size_t const istream_buffer
Number of bytes to use for temporary istream read buffers.
Definition constants.hpp:74
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.
Definition constants.hpp:68
static char const header_delimiter[]
Literal value of the HTTP header delimiter.
Definition constants.hpp:59
bool is_whitespace_char(unsigned char c)
Is the character whitespace.
static char const header_token[]
invalid HTTP token characters
Definition constants.hpp:81
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.
Definition constants.hpp:48
bool is_token_char(unsigned char c)
Is the character a token.
static std::string const empty_header
Literal value of an empty header.
Definition constants.hpp:65
Constants related to processing WebSocket connections.
Definition base.hpp:44
Processor class related error codes.
Definition base.hpp:54
Error code category and codes used by all processor types.
Definition base.hpp:65
lib::error_category const & get_processor_category()
Get a reference to a static copy of the processor error category.
Definition base.hpp:238
close::status::value to_ws(lib::error_code ec)
Converts a processor error_code into a websocket close code.
Definition base.hpp:261
@ missing_required_header
Missing Required Header.
Definition base.hpp:129
@ control_too_big
Control frame too large.
Definition base.hpp:90
@ invalid_http_method
Invalid HTTP method.
Definition base.hpp:120
@ invalid_rsv_bit
Illegal use of reserved bit.
Definition base.hpp:93
@ reason_requires_code
Using a reason requires a close code.
Definition base.hpp:144
@ invalid_close_code
Invalid close code used.
Definition base.hpp:141
@ masking_required
Clients may not send unmasked frames.
Definition base.hpp:102
@ protocol_violation
Processor encountered a protocol violation in an incoming message.
Definition base.hpp:75
@ extensions_disabled
Extension related operation was ignored because extensions are disabled.
Definition base.hpp:153
@ reserved_close_code
Reserved close code used.
Definition base.hpp:138
@ extension_parse_error
Error parsing extensions.
Definition base.hpp:150
@ masking_forbidden
Servers may not send masked frames.
Definition base.hpp:105
@ not_implemented
Operation required not implemented functionality.
Definition base.hpp:117
@ invalid_opcode
Opcode was invalid for requested operation.
Definition base.hpp:87
@ sha1_library
Embedded SHA-1 library error.
Definition base.hpp:132
@ requires_64bit
Not supported on 32 bit systems.
Definition base.hpp:111
@ subprotocol_parse_error
Error parsing subprotocols.
Definition base.hpp:147
@ bad_request
Error was the result of improperly formatted user input.
Definition base.hpp:72
@ invalid_utf8
Invalid UTF-8 encoding.
Definition base.hpp:114
@ invalid_http_status
Invalid HTTP status.
Definition base.hpp:126
@ invalid_payload
Processor encountered invalid payload data.
Definition base.hpp:81
@ invalid_http_version
Invalid HTTP version.
Definition base.hpp:123
@ message_too_big
Processor encountered a message that was too large.
Definition base.hpp:78
@ no_protocol_support
No support for this feature in this protocol version.
Definition base.hpp:135
@ invalid_arguments
The processor method was called with invalid arguments.
Definition base.hpp:84
@ invalid_continuation
Continuation without message.
Definition base.hpp:99
@ non_minimal_encoding
Payload length not minimally encoded.
Definition base.hpp:108
@ fragmented_control
Fragmented control message.
Definition base.hpp:96
lib::error_code make_error_code(error::processor_errors e)
Create an error code with the given value and the processor category.
Definition base.hpp:244
Processors encapsulate the protocol rules specific to each WebSocket version.
Definition processor.hpp:59
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.
Definition processor.hpp:68
Stub RNG policy that always returns 0.
Definition none.hpp:35
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.
Definition none.hpp:51
Asio transport errors.
Definition base.hpp:161
lib::error_category const & get_category()
Get a reference to a static copy of the asio transport error category.
Definition base.hpp:211
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
Definition base.hpp:217
@ proxy_invalid
Invalid Proxy URI.
Definition base.hpp:177
@ pass_through
there was an error in the underlying transport library
Definition base.hpp:171
@ proxy_failed
The connection to the requested proxy server failed.
Definition base.hpp:174
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:168
@ invalid_host_service
Invalid host or service.
Definition base.hpp:180
Errors related to asio transport sockets.
Definition base.hpp:75
@ missing_tls_init_handler
Required tls_init handler not present.
Definition base.hpp:99
@ invalid_state
A function was called in a state that it was illegal to do so.
Definition base.hpp:86
@ tls_failed_sni_hostname
Failed to set TLS SNI hostname.
Definition base.hpp:105
@ tls_handshake_failed
TLS Handshake Failed.
Definition base.hpp:102
@ tls_handshake_timeout
TLS Handshake Timeout.
Definition base.hpp:93
@ pass_through
pass_through from underlying library
Definition base.hpp:96
Transport policy that uses asio.
Definition endpoint.hpp:46
Generic transport related errors.
@ pass_through
underlying transport pass through
@ operation_not_supported
Operation not supported.
@ operation_aborted
Operation aborted.
@ 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
Definition base.hpp:64
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:71
@ double_read
async_read called while another async_read was in progress
Definition base.hpp:74
lib::error_code make_error_code(error::value e)
Get an error code with the given value and the iostream transport category.
Definition base.hpp:118
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition base.hpp:112
Transport policy that uses STL iostream for I/O and does not support timers.
Definition endpoint.hpp:43
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition base.hpp:57
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition base.hpp:61
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.
Definition base.hpp:48
Transport policies provide network connectivity and timers.
Definition endpoint.hpp:45
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.
Definition endpoint.hpp:80
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.
Definition endpoint.hpp:83
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.
Definition uri.hpp:52
bool digit(char c)
RFC3986 digit character test.
Definition uri.hpp:184
bool gen_delim(char c)
RFC3986 generic delimiter character test.
Definition uri.hpp:78
bool digit(std::string::const_iterator it)
RFC3986 digit character test (iterator version).
Definition uri.hpp:195
bool ipv4_literal(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv4 literal.
Definition uri.hpp:250
bool sub_delim(char c)
RFC3986 subcomponent delimiter character test.
Definition uri.hpp:100
bool reg_name(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for validity for a registry name.
Definition uri.hpp:373
bool pct_encoded(std::string::const_iterator it)
RFC3986 per cent encoded character test.
Definition uri.hpp:211
bool scheme(char c)
RFC3986 scheme character test.
Definition uri.hpp:165
bool unreserved(char c)
RFC3986 unreserved character test.
Definition uri.hpp:61
bool reg_name(char c)
Tests a character for validity for a registry name.
Definition uri.hpp:361
bool hex4(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv6 hex quad.
Definition uri.hpp:279
bool dec_octet(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv4 decimal octet.
Definition uri.hpp:223
bool ipv6_literal(std::string::const_iterator start, std::string::const_iterator end)
Tests a range for a valid IPv6 literal.
Definition uri.hpp:299
bool hexdigit(char c)
RFC3986 hex digit character test.
Definition uri.hpp:128
Generic non-websocket specific utility functions and data structures.
Definition utilities.hpp:39
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://.
Definition uri.hpp:47
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://.
Definition uri.hpp:45
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.
Definition version.hpp:57
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition uri.hpp:791
std::pair< lib::error_code, std::string > err_str_pair
Combination error code / string type for returning two values.
Definition error.hpp:41
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.
Definition base64.hpp:53
std::string base64_encode(unsigned char const *input, size_t len)
Encode a char buffer into a base64 string.
Definition base64.hpp:66
#define TYP_BIGE
Definition network.hpp:53
#define TYP_SMLE
Definition network.hpp:52
#define TYP_INIT
Definition network.hpp:51
Server config with asio transport and TLS disabled.
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition core.hpp:137
static const long timeout_connect
Length of time to wait for TCP connect.
Definition core.hpp:134
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition core.hpp:131
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition core.hpp:121
static const long timeout_socket_pre_init
Default timer values (in ms).
Definition core.hpp:118
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition core.hpp:128
Server config with iostream transport.
Definition core.hpp:68
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition core.hpp:93
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition core.hpp:176
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition core.hpp:142
static const size_t max_http_body_size
Default maximum http body size.
Definition core.hpp:252
static const long timeout_open_handshake
Default timer values (in ms).
Definition core.hpp:152
static const size_t max_message_size
Default maximum message size.
Definition core.hpp:240
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition core.hpp:213
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition core.hpp:154
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition core.hpp:189
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition core.hpp:88
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition core.hpp:156
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition core.hpp:228
static bool const enable_multithreading
Definition core.hpp:98
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition core.hpp:204
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition core.hpp:255
static const int client_version
WebSocket Protocol version to use as a client.
Definition core.hpp:164
The constant size component of a WebSocket frame header.
Definition frame.hpp:189
The variable size component of a WebSocket frame header.
Definition frame.hpp:235
Package of log levels for logging access events.
Definition levels.hpp:112
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
Definition levels.hpp:164
static level const fail
One line for each failed WebSocket connection with details.
Definition levels.hpp:147
static level const none
Special aggregate value representing "no levels".
Definition levels.hpp:114
static level const debug_handshake
Extra information about opening handshakes.
Definition levels.hpp:137
static level const devel
Development messages (warning: very chatty).
Definition levels.hpp:141
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:152
static level const debug_close
Extra information about closing handshakes.
Definition levels.hpp:139
static level const frame_payload
One line per frame, includes the full message payload (warning: chatty).
Definition levels.hpp:129
static level const connect
Information about new connections.
Definition levels.hpp:121
static level const app
Special channel for application specific logs. Not used by the library.
Definition levels.hpp:143
static level const frame_header
One line per frame, includes the full frame header.
Definition levels.hpp:127
static level const message_payload
Reserved.
Definition levels.hpp:133
static level const endpoint
Reserved.
Definition levels.hpp:135
static level const message_header
Reserved.
Definition levels.hpp:131
static level const control
One line per control frame.
Definition levels.hpp:125
static level const disconnect
One line for each closed connection. Includes closing codes and reasons.
Definition levels.hpp:123
static level const access_core
Definition levels.hpp:150
static level const http
Access related to HTTP requests.
Definition levels.hpp:145
Package of values for hinting at the nature of a given logger.
Definition levels.hpp:46
static value const none
No information.
Definition levels.hpp:51
static value const access
Access log.
Definition levels.hpp:53
static value const error
Error log.
Definition levels.hpp:55
uint32_t value
Type of a channel type hint value.
Definition levels.hpp:48
Package of log levels for logging errors.
Definition levels.hpp:59
static level const devel
Low level debugging information (warning: very chatty).
Definition levels.hpp:63
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
Definition levels.hpp:91
static level const library
Definition levels.hpp:66
static level const info
Definition levels.hpp:69
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:80
static level const fatal
Definition levels.hpp:78
static level const none
Special aggregate value representing "no levels".
Definition levels.hpp:61
static level const rerror
Definition levels.hpp:75
static level const warn
Definition levels.hpp:72
A simple utility buffer class.
Helper less than functor for case insensitive find.
Definition utilities.hpp:75
Helper functor for case insensitive find.
Definition utilities.hpp:49
bool operator()(charT ch1, charT ch2)
Perform a case insensitive comparison.
Definition utilities.hpp:63
my_equal(std::locale const &loc)
Construct the functor with the given locale.
Definition utilities.hpp:54
#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.
Definition close.hpp:275
Two byte conversion union.
Definition frame.hpp:55
Four byte conversion union.
Definition frame.hpp:61
Eight byte conversion union.
Definition frame.hpp:67