websocketpp  0.3.0
C++/Boost Asio based websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
connection.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_HPP
29 #define WEBSOCKETPP_CONNECTION_HPP
30 
31 #include <websocketpp/close.hpp>
32 #include <websocketpp/common/connection_hdl.hpp>
33 #include <websocketpp/common/cpp11.hpp>
34 #include <websocketpp/common/functional.hpp>
35 #include <websocketpp/error.hpp>
36 #include <websocketpp/frame.hpp>
37 #include <websocketpp/http/constants.hpp>
38 #include <websocketpp/logger/levels.hpp>
39 #include <websocketpp/processors/processor.hpp>
40 #include <websocketpp/transport/base/connection.hpp>
41 
42 #include <algorithm>
43 #include <iostream>
44 #include <queue>
45 #include <sstream>
46 #include <string>
47 #include <vector>
48 
49 namespace websocketpp {
50 
52 
59 typedef lib::function<void(connection_hdl)> open_handler;
60 
62 
69 typedef lib::function<void(connection_hdl)> close_handler;
70 
72 
79 typedef lib::function<void(connection_hdl)> fail_handler;
80 
82 
91 typedef lib::function<void(connection_hdl)> interrupt_handler;
92 
94 
101 typedef lib::function<bool(connection_hdl,std::string)> ping_handler;
102 
104 
109 typedef lib::function<void(connection_hdl,std::string)> pong_handler;
110 
112 
116 typedef lib::function<void(connection_hdl,std::string)> pong_timeout_handler;
117 
119 
129 typedef lib::function<bool(connection_hdl)> validate_handler;
130 
132 
151 typedef lib::function<void(connection_hdl)> http_handler;
152 
153 //
154 typedef lib::function<void(lib::error_code const & ec, size_t bytes_transferred)> read_handler;
155 typedef lib::function<void(lib::error_code const & ec)> write_frame_handler;
156 
157 // constants related to the default WebSocket protocol versions available
158 #ifdef _WEBSOCKETPP_INITIALIZER_LISTS_ // simplified C++11 version
159 
164  static std::vector<int> const versions_supported = {0,7,8,13};
165 #else
166  static int const helper[] = {0,7,8,13};
169 
173  static std::vector<int> const versions_supported(helper,helper+4);
174 #endif
175 
176 namespace session {
177 namespace state {
178  // externally visible session state (states based on the RFC)
179  enum value {
180  connecting = 0,
181  open = 1,
182  closing = 2,
183  closed = 3
184  };
185 } // namespace state
186 
187 
188 namespace fail {
189 namespace status {
190  enum value {
191  GOOD = 0, // no failure yet!
192  SYSTEM = 1, // system call returned error, check that code
193  WEBSOCKET = 2, // websocket close codes contain error
194  UNKNOWN = 3, // No failure information is available
195  TIMEOUT_TLS = 4, // TLS handshake timed out
196  TIMEOUT_WS = 5 // WS handshake timed out
197  };
198 } // namespace status
199 } // namespace fail
200 
201 namespace internal_state {
202  // More granular internal states. These are used for multi-threaded
203  // connection synchronization and preventing values that are not yet or no
204  // longer available from being used.
205 
206  enum value {
207  USER_INIT = 0,
208  TRANSPORT_INIT = 1,
209  READ_HTTP_REQUEST = 2,
210  WRITE_HTTP_REQUEST = 3,
211  READ_HTTP_RESPONSE = 4,
212  WRITE_HTTP_RESPONSE = 5,
213  PROCESS_HTTP_REQUEST = 6,
214  PROCESS_CONNECTION = 7
215  };
216 } // namespace internal_state
217 } // namespace session
218 
220 template <typename config>
222  : public config::transport_type::transport_con_type
223  , public config::connection_base
224 {
225 public:
229  typedef lib::shared_ptr<type> ptr;
231  typedef lib::weak_ptr<type> weak_ptr;
232 
234  typedef typename config::concurrency_type concurrency_type;
236  typedef typename config::alog_type alog_type;
238  typedef typename config::elog_type elog_type;
239 
241  typedef typename config::transport_type::transport_con_type
244  typedef typename transport_con_type::ptr transport_con_ptr;
245 
246  typedef lib::function<void(ptr)> termination_handler;
247 
248  typedef typename concurrency_type::scoped_lock_type scoped_lock_type;
249  typedef typename concurrency_type::mutex_type mutex_type;
250 
251  typedef typename config::request_type request_type;
252  typedef typename config::response_type response_type;
253 
254  typedef typename config::message_type message_type;
255  typedef typename message_type::ptr message_ptr;
256 
257  typedef typename config::con_msg_manager_type con_msg_manager_type;
258  typedef typename con_msg_manager_type::ptr con_msg_manager_ptr;
259 
261  typedef typename config::rng_type rng_type;
262 
264  typedef lib::shared_ptr<processor_type> processor_ptr;
265 
266  // Message handler (needs to know message type)
267  typedef lib::function<void(connection_hdl,message_ptr)> message_handler;
268 
270  typedef typename transport_con_type::timer_ptr timer_ptr;
271 
272  // Misc Convenience Types
273  typedef session::internal_state::value istate_type;
274 
275 private:
276  enum terminate_status {
277  failed = 1,
278  closed,
279  unknown
280  };
281 public:
282 
283  explicit connection(bool p_is_server, std::string const & ua, alog_type& alog,
284  elog_type& elog, rng_type & rng)
285  : transport_con_type(p_is_server, alog, elog)
286  , m_handle_read_frame(lib::bind(
287  &type::handle_read_frame,
288  this,
289  lib::placeholders::_1,
290  lib::placeholders::_2
291  ))
292  , m_write_frame_handler(lib::bind(
293  &type::handle_write_frame,
294  this,
295  lib::placeholders::_1
296  ))
297  , m_user_agent(ua)
298  , m_open_handshake_timeout_dur(config::timeout_open_handshake)
299  , m_close_handshake_timeout_dur(config::timeout_close_handshake)
300  , m_pong_timeout_dur(config::timeout_pong)
301  , m_max_message_size(config::max_message_size)
302  , m_state(session::state::connecting)
303  , m_internal_state(session::internal_state::USER_INIT)
304  , m_msg_manager(new con_msg_manager_type())
305  , m_send_buffer_size(0)
306  , m_write_flag(false)
307  , m_read_flag(true)
308  , m_is_server(p_is_server)
309  , m_alog(alog)
310  , m_elog(elog)
311  , m_rng(rng)
312  , m_local_close_code(close::status::abnormal_close)
313  , m_remote_close_code(close::status::abnormal_close)
314  , m_was_clean(false)
315  {
316  m_alog.write(log::alevel::devel,"connection constructor");
317  }
318 
320  ptr get_shared() {
321  return lib::static_pointer_cast<type>(transport_con_type::get_shared());
322  }
323 
325  // Set Handler Callbacks //
327 
329 
335  void set_open_handler(open_handler h) {
336  m_open_handler = h;
337  }
338 
340 
345  void set_close_handler(close_handler h) {
346  m_close_handler = h;
347  }
348 
350 
356  void set_fail_handler(fail_handler h) {
357  m_fail_handler = h;
358  }
359 
361 
371  void set_ping_handler(ping_handler h) {
372  m_ping_handler = h;
373  }
374 
376 
382  void set_pong_handler(pong_handler h) {
383  m_pong_handler = h;
384  }
385 
387 
405  void set_pong_timeout_handler(pong_timeout_handler h) {
406  m_pong_timeout_handler = h;
407  }
408 
410 
416  void set_interrupt_handler(interrupt_handler h) {
417  m_interrupt_handler = h;
418  }
419 
421 
431  void set_http_handler(http_handler h) {
432  m_http_handler = h;
433  }
434 
436 
447  void set_validate_handler(validate_handler h) {
448  m_validate_handler = h;
449  }
450 
452 
457  void set_message_handler(message_handler h) {
458  m_message_handler = h;
459  }
460 
462  // Connection timeouts and other limits //
464 
466 
485  void set_open_handshake_timeout(long dur) {
486  m_open_handshake_timeout_dur = dur;
487  }
488 
490 
510  m_close_handshake_timeout_dur = dur;
511  }
512 
514 
530  void set_pong_timeout(long dur) {
531  m_pong_timeout_dur = dur;
532  }
533 
535 
543  size_t get_max_message_size() const {
544  return m_max_message_size;
545  }
546 
548 
559  void set_max_message_size(size_t new_value) {
560  m_max_message_size = new_value;
561  if (m_processor) {
562  m_processor->set_max_message_size(new_value);
563  }
564  }
565 
567  // Uncategorized public methods //
569 
571 
581  size_t get_buffered_amount() const;
582 
584  size_t buffered_amount() const {
585  return get_buffered_amount();
586  }
587 
589  // Action Methods //
591 
593 
604  lib::error_code send(std::string const & payload, frame::opcode::value op =
605  frame::opcode::text);
606 
608 
621  lib::error_code send(void const * payload, size_t len, frame::opcode::value
622  op = frame::opcode::binary);
623 
625 
637  lib::error_code send(message_ptr msg);
638 
640 
652  lib::error_code interrupt();
653 
655  void handle_interrupt();
656 
658 
677  lib::error_code pause_reading();
678 
680  void handle_pause_reading();
681 
683 
689  lib::error_code resume_reading();
690 
692  void handle_resume_reading();
693 
695 
706  void ping(std::string const & payload);
707 
709  void ping(std::string const & payload, lib::error_code & ec);
710 
712  void handle_pong_timeout(std::string payload, lib::error_code const & ec);
713 
715 
724  void pong(std::string const & payload);
725 
727  void pong(std::string const & payload, lib::error_code & ec);
728 
730 
749  void close(close::status::value const code, std::string const & reason);
750 
752  void close(close::status::value const code, std::string const & reason,
753  lib::error_code & ec);
754 
756  // Pass-through access to the uri information //
758 
760 
766  bool get_secure() const;
767 
769 
775  std::string const & get_host() const;
776 
778 
784  std::string const & get_resource() const;
785 
787 
793  uint16_t get_port() const;
794 
796 
802  uri_ptr get_uri() const;
803 
805 
811  void set_uri(uri_ptr uri);
812 
814  // Subprotocol negotiation //
816 
818 
824  std::string const & get_subprotocol() const;
825 
827 
833  std::vector<std::string> const & get_requested_subprotocols() const;
834 
836 
848  void add_subprotocol(std::string const & request, lib::error_code & ec);
849 
851 
861  void add_subprotocol(std::string const & request);
862 
864 
876  void select_subprotocol(std::string const & value, lib::error_code & ec);
877 
879 
889  void select_subprotocol(std::string const & value);
890 
892  // Pass-through access to the request and response objects //
894 
896 
902  std::string const & get_request_header(std::string const & key);
903 
905 
911  std::string const & get_response_header(std::string const & key);
912 
914 
927  void set_status(http::status_code::value code);
928 
930 
942  void set_status(http::status_code::value code, std::string const & msg);
943 
945 
957  void set_body(std::string const & value);
958 
960 
973  void append_header(std::string const & key, std::string const & val);
974 
976 
988  void replace_header(std::string const & key, std::string const & val);
989 
991 
1000  void remove_header(std::string const & key);
1001 
1003 
1016  request_type const & get_request() const {
1017  return m_request;
1018  }
1019 
1021  // Pass-through access to the other connection information //
1023 
1025 
1033  return m_connection_hdl;
1034  }
1035 
1037 
1040  bool is_server() const {
1041  return m_is_server;
1042  }
1043 
1045 
1051  std::string const & get_origin() const;
1052 
1054 
1059  session::state::value get_state() const;
1060 
1061 
1063 
1067  return m_local_close_code;
1068  }
1069 
1071 
1074  std::string const & get_local_close_reason() const {
1075  return m_local_close_reason;
1076  }
1077 
1079 
1083  return m_remote_close_code;
1084  }
1085 
1087 
1090  std::string const & get_remote_close_reason() const {
1091  return m_remote_close_reason;
1092  }
1093 
1095 
1103  lib::error_code get_ec() const {
1104  return m_ec;
1105  }
1106 
1108  // The remaining public member functions are for internal/policy use //
1109  // only. Do not call from application code unless you understand what //
1110  // you are doing. //
1112 
1114 
1123  m_connection_hdl = hdl;
1124  transport_con_type::set_handle(hdl);
1125  }
1126 
1128 
1146  message_ptr get_message(websocketpp::frame::opcode::value op, size_t size)
1147  const
1148  {
1149  return m_msg_manager->get_message(op, size);
1150  }
1151 
1152  void start();
1153 
1154  void read_handshake(size_t num_bytes);
1155 
1156  void handle_read_handshake(lib::error_code const & ec,
1157  size_t bytes_transferred);
1158  void handle_read_http_response(lib::error_code const & ec,
1159  size_t bytes_transferred);
1160 
1161  void handle_send_http_response(lib::error_code const & ec);
1162  void handle_send_http_request(lib::error_code const & ec);
1163 
1164  void handle_open_handshake_timeout(lib::error_code const & ec);
1165  void handle_close_handshake_timeout(lib::error_code const & ec);
1166 
1167  void handle_read_frame(lib::error_code const & ec, size_t bytes_transferred);
1168  void read_frame();
1169 
1171  const std::vector<int>& get_supported_versions() const;
1172 
1175  void set_termination_handler(termination_handler new_handler);
1176 
1177  void terminate(lib::error_code const & ec);
1178  void handle_terminate(terminate_status tstat, lib::error_code const & ec);
1179 
1181 
1186  void write_frame();
1187 
1189 
1200  void handle_write_frame(lib::error_code const & ec);
1201 protected:
1202  void handle_transport_init(lib::error_code const & ec);
1203 
1206  bool initialize_processor();
1207 
1211 
1213 
1221  void atomic_state_change(istate_type req, istate_type dest,
1222  std::string msg);
1223 
1225 
1238  void atomic_state_change(istate_type ireq, istate_type idest,
1239  session::state::value ereq, session::state::value edest,
1240  std::string msg);
1241 
1243 
1249  void atomic_state_check(istate_type req, std::string msg);
1250 private:
1252  void send_http_response();
1253 
1255  void send_http_request();
1256 
1258  void send_http_response_error();
1259 
1261 
1264  void process_control_frame(message_ptr msg);
1265 
1267 
1277  lib::error_code send_close_ack(close::status::value code =
1278  close::status::blank, std::string const & reason = "");
1279 
1281 
1295  lib::error_code send_close_frame(close::status::value code =
1296  close::status::blank, std::string const & reason = "", bool ack = false,
1297  bool terminal = false);
1298 
1300 
1309  processor_ptr get_processor(int version) const;
1310 
1312 
1321  void write_push(message_ptr msg);
1322 
1324 
1334  message_ptr write_pop();
1335 
1337 
1342  void log_open_result();
1343 
1345 
1348  void log_close_result();
1349 
1351 
1354  void log_fail_result();
1355 
1357  template <typename error_type>
1358  void log_err(log::level l, char const * msg, error_type const & ec) {
1359  std::stringstream s;
1360  s << msg << " error: " << ec << " (" << ec.message() << ")";
1361  m_elog.write(l, s.str());
1362  }
1363 
1364  // internal handler functions
1365  read_handler m_handle_read_frame;
1366  write_frame_handler m_write_frame_handler;
1367 
1368  // static settings
1369  std::string const m_user_agent;
1370 
1372  connection_hdl m_connection_hdl;
1373 
1375  open_handler m_open_handler;
1376  close_handler m_close_handler;
1377  fail_handler m_fail_handler;
1378  ping_handler m_ping_handler;
1379  pong_handler m_pong_handler;
1380  pong_timeout_handler m_pong_timeout_handler;
1381  interrupt_handler m_interrupt_handler;
1382  http_handler m_http_handler;
1383  validate_handler m_validate_handler;
1384  message_handler m_message_handler;
1385 
1387  long m_open_handshake_timeout_dur;
1388  long m_close_handshake_timeout_dur;
1389  long m_pong_timeout_dur;
1390  size_t m_max_message_size;
1391 
1393 
1396  session::state::value m_state;
1397 
1399 
1402  istate_type m_internal_state;
1403 
1404  mutable mutex_type m_connection_state_lock;
1405 
1407 
1411  mutex_type m_write_lock;
1412 
1413  // connection resources
1414  char m_buf[config::connection_read_buffer_size];
1415  size_t m_buf_cursor;
1416  termination_handler m_termination_handler;
1417  con_msg_manager_ptr m_msg_manager;
1418  timer_ptr m_handshake_timer;
1419  timer_ptr m_ping_timer;
1420 
1423  std::string m_handshake_buffer;
1424 
1426 
1434  processor_ptr m_processor;
1435 
1437 
1440  std::queue<message_ptr> m_send_queue;
1441 
1443 
1446  size_t m_send_buffer_size;
1447 
1449 
1452  std::vector<transport::buffer> m_send_buffer;
1453 
1456  std::vector<message_ptr> m_current_msgs;
1457 
1459 
1462  bool m_write_flag;
1463 
1465  bool m_read_flag;
1466 
1467  // connection data
1468  request_type m_request;
1469  response_type m_response;
1470  uri_ptr m_uri;
1471  std::string m_subprotocol;
1472 
1473  // connection data that might not be necessary to keep around for the life
1474  // of the whole connection.
1475  std::vector<std::string> m_requested_subprotocols;
1476 
1477  bool const m_is_server;
1478  alog_type& m_alog;
1479  elog_type& m_elog;
1480 
1481  rng_type & m_rng;
1482 
1483  // Close state
1485  close::status::value m_local_close_code;
1486 
1488  std::string m_local_close_reason;
1489 
1491  close::status::value m_remote_close_code;
1492 
1494  std::string m_remote_close_reason;
1495 
1497  lib::error_code m_ec;
1498 
1499  bool m_was_clean;
1500 
1502  bool m_closed_by_me;
1503 
1505  bool m_failed_by_me;
1506 
1508  bool m_dropped_by_me;
1509 };
1510 
1511 } // namespace websocketpp
1512 
1513 #include <websocketpp/impl/connection_impl.hpp>
1514 
1515 #endif // WEBSOCKETPP_CONNECTION_HPP
std::string const & get_remote_close_reason() const
Get the WebSocket close reason sent by the remote endpoint.
void add_subprotocol(std::string const &request, lib::error_code &ec)
Adds the given subprotocol string to the request list (exception free)
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
Definition: connection.hpp:485
void set_termination_handler(termination_handler new_handler)
connection_hdl get_handle() const
Get Connection Handle.
void set_pong_timeout(long dur)
Set pong timeout.
Definition: connection.hpp:530
ptr get_shared()
Get a shared pointer to this component.
Definition: connection.hpp:320
void read_frame()
Issue a new transport read unless reading is paused.
std::string const & get_subprotocol() const
Gets the negotated subprotocol.
uint16_t value
The type of a close code value.
Definition: close.hpp:49
message_ptr get_message(websocketpp::frame::opcode::value op, size_t size) const
Get a message buffer.
std::string const & get_origin() const
Return the same origin policy origin value from the opening request.
bool terminal(value code)
Determine if the code represents an unrecoverable error.
Definition: close.hpp:197
lib::function< void(connection_hdl)> close_handler
The type and function signature of a close handler.
Definition: connection.hpp:69
lib::error_code pause_reading()
Pause reading of new data.
lib::function< void(connection_hdl)> open_handler
The type and function signature of an open handler.
Definition: connection.hpp:59
close::status::value get_local_close_code() const
Get the WebSocket close code sent by this endpoint.
lib::function< void(connection_hdl, std::string)> pong_timeout_handler
The type and function signature of a pong timeout handler.
Definition: connection.hpp:116
std::string const & get_local_close_reason() const
Get the WebSocket close reason sent by this endpoint.
session::state::value get_state() const
Return the connection state.
static std::vector< int > const versions_supported(helper, helper+4)
Container that stores the list of protocol versions supported.
lib::function< void(connection_hdl)> interrupt_handler
The type and function signature of an interrupt handler.
Definition: connection.hpp:91
transport_con_type::ptr transport_con_ptr
Type of a shared pointer to the transport component of this connection.
Definition: connection.hpp:244
void set_open_handler(open_handler h)
Set open handler.
Definition: connection.hpp:335
WebSocket protocol processor abstract base class.
Definition: processor.hpp:154
lib::function< bool(connection_hdl, std::string)> ping_handler
The type and function signature of a ping handler.
Definition: connection.hpp:101
uri_ptr get_uri() const
Gets the connection URI.
void replace_header(std::string const &key, std::string const &val)
Replace a header.
void ping(std::string const &payload)
Send a ping.
lib::weak_ptr< type > weak_ptr
Type of a weak pointer to this connection.
Definition: connection.hpp:231
Represents an individual WebSocket connection.
Definition: connection.hpp:221
void set_fail_handler(fail_handler h)
Set fail handler.
Definition: connection.hpp:356
size_t get_buffered_amount() const
Get the size of the outgoing write buffer (in payload bytes)
std::string const & get_request_header(std::string const &key)
Retrieve a request header.
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
void set_http_handler(http_handler h)
Set http handler.
Definition: connection.hpp:431
void select_subprotocol(std::string const &value, lib::error_code &ec)
Select a subprotocol to use (exception free)
void set_close_handler(close_handler h)
Set close handler.
Definition: connection.hpp:345
lib::error_code get_ec() const
Get the internal error code for a closed/failed connection.
void pong(std::string const &payload)
Send a pong.
void atomic_state_check(istate_type req, std::string msg)
Atomically read and compared the internal state.
void handle_resume_reading()
Resume reading callback.
config::alog_type alog_type
Type of the access logging policy.
Definition: connection.hpp:236
std::string const & get_resource() const
Returns the resource component of the connection URI.
static level const devel
Development messages (warning: very chatty)
Definition: levels.hpp:122
lib::function< bool(connection_hdl)> validate_handler
The type and function signature of a validate handler.
Definition: connection.hpp:129
close::status::value get_remote_close_code() const
Get the WebSocket close code sent by the remote endpoint.
const std::vector< int > & get_supported_versions() const
Get array of WebSocket protocol versions that this connection supports.
void set_pong_handler(pong_handler h)
Set pong handler.
Definition: connection.hpp:382
connection< config > type
Type of this connection.
Definition: connection.hpp:227
std::string const & get_host() const
Returns the host component of the connection URI.
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
Definition: connection.hpp:509
lib::error_code resume_reading()
Resume reading of new data.
bool is_server() const
Get whether or not this connection is part of a server or client.
void close(close::status::value const code, std::string const &reason)
Close the connection.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void atomic_state_change(istate_type req, istate_type dest, std::string msg)
Atomically change the internal connection state.
void set_status(http::status_code::value code)
Set response status code and message.
void handle_pong_timeout(std::string payload, lib::error_code const &ec)
Utility method that gets called back when the ping timer expires.
config::concurrency_type concurrency_type
Type of the concurrency component of this connection.
Definition: connection.hpp:234
config::rng_type rng_type
Type of RNG.
Definition: connection.hpp:261
void append_header(std::string const &key, std::string const &val)
Append a header.
lib::error_code send(std::string const &payload, frame::opcode::value op=frame::opcode::text)
Create a message and then add it to the outgoing send queue.
config::transport_type::transport_con_type transport_con_type
Type of the transport component of this connection.
Definition: connection.hpp:242
lib::function< void(connection_hdl)> http_handler
The type and function signature of a http handler.
Definition: connection.hpp:151
void set_ping_handler(ping_handler h)
Set ping handler.
Definition: connection.hpp:371
void write_frame()
Checks if there are frames in the send queue and if there are sends one.
void handle_write_frame(lib::error_code const &ec)
Process the results of a frame write operation and start the next write.
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
void set_max_message_size(size_t new_value)
Set maximum message size.
Definition: connection.hpp:559
void set_pong_timeout_handler(pong_timeout_handler h)
Set pong timeout handler.
Definition: connection.hpp:405
uint16_t get_port() const
Returns the port component of the connection URI.
std::string const & get_response_header(std::string const &key)
Retrieve a response header.
void set_interrupt_handler(interrupt_handler h)
Set interrupt handler.
Definition: connection.hpp:416
request_type const & get_request() const
Get request object.
static int const helper[]
Helper array to get around lack of initializer lists pre C++11.
Definition: connection.hpp:167
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition: uri.hpp:350
void handle_interrupt()
Transport inturrupt callback.
void handle_pause_reading()
Pause reading callback.
void set_validate_handler(validate_handler h)
Set validate handler.
Definition: connection.hpp:447
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection.
Definition: connection.hpp:229
size_t get_max_message_size() const
Get maximum message size.
Definition: connection.hpp:543
void set_message_handler(message_handler h)
Set message handler.
Definition: connection.hpp:457
std::vector< std::string > const & get_requested_subprotocols() const
Gets all of the subprotocols requested by the client.
bool get_secure() const
Returns the secure flag from the connection URI.
static value const abnormal_close
A dummy value to indicate that the connection was closed abnormally.
Definition: close.hpp:104
size_t buffered_amount() const
DEPRECATED: use get_buffered_amount instead.
Definition: connection.hpp:584
lib::function< void(connection_hdl, std::string)> pong_handler
The type and function signature of a pong handler.
Definition: connection.hpp:109
void set_uri(uri_ptr uri)
Sets the connection URI.
lib::error_code interrupt()
Asyncronously invoke handler::on_inturrupt.
transport_con_type::timer_ptr timer_ptr
Type of a pointer to a transport timer handle.
Definition: connection.hpp:270
lib::function< void(connection_hdl)> fail_handler
The type and function signature of a fail handler.
Definition: connection.hpp:79
config::elog_type elog_type
Type of the error logging policy.
Definition: connection.hpp:238
static value const blank
A blank value for internal use.
Definition: close.hpp:52
void remove_header(std::string const &key)
Remove a header.
void set_body(std::string const &value)
Set response body content.