Loading...
Searching...
No Matches
uri.hpp
/*
* Copyright (c) 2014, Peter Thorson. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the WebSocket++ Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef WEBSOCKETPP_URI_HPP
#define WEBSOCKETPP_URI_HPP
#include <websocketpp/error.hpp>
#include <websocketpp/common/memory.hpp>
#include <websocketpp/common/stdint.hpp>
#include <algorithm>
#include <sstream>
#include <string>
namespace websocketpp {
// TODO: figure out why this fixes horrible linking errors.
/// Default port for ws://
static uint16_t const uri_default_port = 80;
/// Default port for wss://
static uint16_t const uri_default_secure_port = 443;
/// A group of helper methods for parsing and validating URIs against RFC 3986
namespace uri_helper {
/// RFC3986 unreserved character test
/**
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered `unreserved`
*/
inline bool unreserved(char c) {
if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')) {
return true;
} else if (c >= '0' && c <= '9') {
return true;
} else if (c == '-' || c == '.' || c == '_' || c == '~') {
return true;
} else {
return false;
}
}
/// RFC3986 generic delimiter character test
/**
* @param c the char to test
* @return True if the character is considered a generic delimiter
*/
inline bool gen_delim(char c) {
switch(c) {
case ':':
case '/':
case '?':
case '#':
case '[':
case ']':
case '@':
return true;
default:
return false;
}
}
/// RFC3986 subcomponent delimiter character test
/**
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered a subcomponent delimiter
*/
inline bool sub_delim(char c) {
switch(c) {
case '!':
case '$':
case '&':
case '\'':
case '(':
case ')':
case '*':
case '+':
case ',':
case ';':
case '=':
return true;
default:
return false;
}
}
/// RFC3986 hex digit character test
/**
* Case insensitive
*
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered a hexadecimal digit
*/
inline bool hexdigit(char c) {
switch(c) {
case '0':
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
case 'A':
case 'B':
case 'C':
case 'D':
case 'E':
case 'F':
case 'a':
case 'b':
case 'c':
case 'd':
case 'e':
case 'f':
return true;
default:
return false;
}
}
/// RFC3986 scheme character test
/**
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered a valid character for a uri scheme
*/
inline bool scheme(char c) {
if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')) {
return true;
} else if (c >= '0' && c <= '9') {
return true;
} else if (c == '+' || c == '-' || c == '.') {
return true;
} else {
return false;
}
}
/// RFC3986 digit character test
/**
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered a digit (0-9)
*/
inline bool digit(char c) {
return c >= '0' && c <= '9';
}
/// RFC3986 digit character test (iterator version)
/**
* @since 0.8.3
*
* @param c the char to test
* @return True if the character is considered a digit (0-9)
*/
inline bool digit(std::string::const_iterator it) {
return digit(*it);
}
/// RFC3986 per cent encoded character test
/**
* caller must range check (only caller knows the actual range)
* caller must check for leading %
*
* @since 0.8.3
*
* @param it An iterator to the first character after the % sign
* @return True if both the character pointed at by the iterator and
* the next one represent a valid RFC3986 percent encoding
*/
inline bool pct_encoded(std::string::const_iterator it) {
return hexdigit(*it) && hexdigit(*(it + 1));
}
/// Tests a range for a valid IPv4 decimal octet
/**
* @since 0.8.3
*
* @param start An iterator to the first character of the range to check (inclusive)
* @param start An iterator to the last character of the range to check (exclusive)
* @return True if the range represents a valid IPv4 decimal octet (0-255)
*/
inline bool dec_octet(std::string::const_iterator start, std::string::const_iterator end) {
if (end-start == 1) {
return digit(start);
} else if (end-start == 2) {
return ((*start >= '1' && *start <= '9') && digit(start+1));
} else if (end-start == 3) {
if (*start == '1') {
return digit(start+1) && digit(start+2);
} else if (*start == '2') {
if (*(start+1) >= '0' && *(start+1) <= '4') {
return digit(start+2);
} else if (*(start+1) == '5') {
return *(start+2) >= '0' && *(start+2) <= '5';
}
}
}
return false;
}
/// Tests a range for a valid IPv4 literal
/**
* @since 0.8.3
*
* @param start An iterator to the first character of the range to check (inclusive)
* @param start An iterator to the last character of the range to check (exclusive)
* @return True if the range represents a valid IPv4 literal address
*/
inline bool ipv4_literal(std::string::const_iterator start, std::string::const_iterator end) {
std::string::const_iterator cursor = start;
size_t counter = 0;
for (std::string::const_iterator it = start; it != end; ++it) {
if (*it == '.') {
if (dec_octet(cursor,it)) {
cursor = it+1;
counter++;
if (counter > 3) {
return false;
}
} else {
return false;
}
}
}
// check final octet
return (counter == 3 && dec_octet(cursor,end));
}
/// Tests a range for a valid IPv6 hex quad
/**
* @since 0.8.3
*
* @param start An iterator to the first character of the range to check (inclusive)
* @param start An iterator to the last character of the range to check (exclusive)
* @return True if the range represents a valid IPv6 hex quad
*/
inline bool hex4(std::string::const_iterator start, std::string::const_iterator end) {
if (end-start == 0 || end-start >4) {
return false;
}
for (std::string::const_iterator it = start; it != end; ++it) {
if (!hexdigit(*it)) {
return false;
}
}
return true;
}
/// Tests a range for a valid IPv6 literal
/**
* @since 0.8.3
*
* @param start An iterator to the first character of the range to check (inclusive)
* @param start An iterator to the last character of the range to check (exclusive)
* @return True if the range represents a valid IPv6 literal
*/
inline bool ipv6_literal(std::string::const_iterator start, std::string::const_iterator end) {
// initial range check
if (end-start > 45 && end-start >= 2) {
return false;
}
// peal off and count hex4s until we run out of colons,
// note the abbreviation marker if we see one.
std::string::const_iterator cursor = start;
std::string::const_iterator it = start;
size_t count = 0;
size_t abbr = 0;
while (it != end) {
if (*it == ':') {
if (it == start) {
// if a : happens at the beginning, don't check for a hex quad, just advance
// the cursor. The abbreviation marker will be counted on the next pass
cursor++;
} else if (it-cursor == 0) {
// this is a double colon abbreviation marker
cursor++;
abbr++;
} else if (hex4(cursor,it)) {
cursor = it+1;
count++;
} else {
return false;
}
}
it++;
}
// final bit either needs to be a hex4 or an IPv4 literal
if (cursor == end) {
// fine
} else if (hex4(cursor,end)) {
count++;
} else if (ipv4_literal(cursor, end)) {
count += 2;
} else {
return false;
}
if ((abbr == 0 && count != 8) || (abbr == 1 && count > 7) || abbr > 1) {
return false;
}
return true;
}
/// Tests a character for validity for a registry name
/**
* will fail on %, which is valid, but only when used as a part of a multiple
* character escape sequence. Since this test checks a single character it
* can't tell whether a % character is valid so it returns false. The caller
* needs to catch and handle %s in another way.
*
* @since 0.8.3
*
* @param c The character to test
* @return True if the range represents a valid IPv6 literal
*/
inline bool reg_name(char c) {
return unreserved(c) || sub_delim(c);
}
/// Tests a range for validity for a registry name
/**
* @since 0.8.3
*
* @param start An iterator to the first character of the range to check (inclusive)
* @param start An iterator to the last character of the range to check (exclusive)
* @return True if the range represents a valid registry name
*/
inline bool reg_name(std::string::const_iterator start, std::string::const_iterator end) {
std::string::const_iterator it = start;
while (it != end) {
if (*it == '%') {
// check for valid % encoded char
if (it+2 < end && uri_helper::pct_encoded(it+1)) {
it += 3;
continue;
} else {
return false;
}
} else if (!uri_helper::reg_name(*it)) {
return false;
}
++it;
}
return true;
}
} // end namespace uri_helper
class uri {
public:
explicit uri(std::string const & uri_string) : m_valid(false), m_ipv6_literal(false) {
std::string::const_iterator it;
std::string::const_iterator temp;
int state = 0;
it = uri_string.begin();
size_t uri_len = uri_string.length();
// extract scheme. We only consider Websocket and HTTP URI schemes as valid
if (uri_len >= 7 && std::equal(it,it+6,"wss://")) {
m_secure = true;
m_scheme = "wss";
it += 6;
} else if (uri_len >= 6 && std::equal(it,it+5,"ws://")) {
m_secure = false;
m_scheme = "ws";
it += 5;
} else if (uri_len >= 8 && std::equal(it,it+7,"http://")) {
m_secure = false;
m_scheme = "http";
it += 7;
} else if (uri_len >= 9 && std::equal(it,it+8,"https://")) {
m_secure = true;
m_scheme = "https";
it += 8;
} else {
return;
}
// extract host.
// either a host string
// an IPv4 address
// or an IPv6 address
if (*it == '[') {
++it;
// IPv6 literal
// extract IPv6 digits until ]
// TODO: this doesn't work on g++... not sure why
//temp = std::find(it,it2,']');
temp = it;
while (temp != uri_string.end()) {
if (*temp == ']') {
break;
}
++temp;
}
if (temp == uri_string.end()) {
return;
} else {
// validate IPv6 literal parts
if (!uri_helper::ipv6_literal(it,temp)) {
return;
} else {
m_ipv6_literal = true;
}
m_host.append(it,temp);
}
it = temp+1;
if (it == uri_string.end()) {
state = 2;
} else if (*it == '/' || *it == '?' || *it == '#') {
// todo: better path parsing
state = 2;
// we don't increment the iterator here because we want the
// delimiter to be read again as a part of the path
} else if (*it == ':') {
state = 1;
// start reading port after the delimiter
++it;
} else {
// problem
return;
}
} else {
// IPv4 or hostname
// extract until : or first path component
while (state == 0) {
if (it == uri_string.end()) {
state = 2;
break;
} else if (*it == '%') {
// check for valid % encoded char
if (it+2 < uri_string.end() && uri_helper::pct_encoded(it+1)) {
m_host.append(it,it+2);
it += 3;
}
} else if (!uri_helper::reg_name(*it)) {
// we hit one of the general delimiters
if (*it == ':') {
// got host vs port delimiter
// end hostname start port
state = 1;
// start reading port after the delimiter
++it;
} else if (*it == '/' || *it == '#' || *it == '?') {
// one of the normal authority vs path delimiters
// end hostname and start parsing path
state = 2;
// we don't increment the iterator here because we want the
// delimiter to be read again as a part of the path
} else {
// either @, [, or ]
// @ = userinfo fragment
// [ and ] = illegal, basically
return;
}
} else {
m_host += *it;
++it;
}
}
}
// parse port
std::string port;
while (state == 1) {
if (it == uri_string.end()) {
// if we stop parsing the port and there wasn't actually a port
// we have an invalid URI
if (port.empty()) {
return;
}
state = 3;
} else if (uri_helper::digit(it)) {
port += *it;
++it;
} else {
// if we stop parsing the port and there wasn't actually a port
// we have an invalid URI
if (port.empty()) {
return;
}
state = 3;
// we don't increment the iterator here because we want the
// delimiter to be read again as a part of the path
}
}
lib::error_code ec;
m_port = get_port_from_string(port, ec);
if (ec) {
return;
}
// step back one so the first char of the path delimiter doesn't get eaten
m_resource.append(it,uri_string.end());
if (m_resource.empty()) {
m_resource = "/";
}
// todo: validate path component
m_valid = true;
}
uri(bool secure, std::string const & host, uint16_t port,
std::string const & resource)
: m_scheme(secure ? "wss" : "ws")
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_port(port)
, m_secure(secure)
{
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end());
}
uri(bool secure, std::string const & host, std::string const & resource)
: m_scheme(secure ? "wss" : "ws")
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_port(secure ? uri_default_secure_port : uri_default_port)
, m_secure(secure)
{
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end());
}
uri(bool secure, std::string const & host, std::string const & port,
std::string const & resource)
: m_scheme(secure ? "wss" : "ws")
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_secure(secure)
{
lib::error_code ec;
m_port = get_port_from_string(port,ec);
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = !ec && (m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end()));
}
uri(std::string const & scheme, std::string const & host, uint16_t port,
std::string const & resource)
: m_scheme(scheme)
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_port(port)
, m_secure(scheme == "wss" || scheme == "https")
{
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end());
}
uri(std::string scheme, std::string const & host, std::string const & resource)
: m_scheme(scheme)
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_port((scheme == "wss" || scheme == "https") ? uri_default_secure_port : uri_default_port)
, m_secure(scheme == "wss" || scheme == "https")
{
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end());
}
uri(std::string const & scheme, std::string const & host,
std::string const & port, std::string const & resource)
: m_scheme(scheme)
, m_host(host)
, m_resource(resource.empty() ? "/" : resource)
, m_secure(scheme == "wss" || scheme == "https")
{
lib::error_code ec;
m_port = get_port_from_string(port,ec);
m_ipv6_literal = uri_helper::ipv6_literal(host.begin(), host.end());
m_valid = !ec && (m_ipv6_literal || uri_helper::reg_name(host.begin(), host.end()));
}
bool get_valid() const {
return m_valid;
}
// Check whether the host of this URI is an IPv6 literal address
/**
* @since 0.8.3
* @return True if the host of this URI is an IPv6 literal address
*/
bool is_ipv6_literal() const {
return m_ipv6_literal;
}
bool get_secure() const {
return m_secure;
}
std::string const & get_scheme() const {
return m_scheme;
}
std::string const & get_host() const {
return m_host;
}
std::string get_host_port() const {
if (m_port == (m_secure ? uri_default_secure_port : uri_default_port)) {
// todo: should this have brackets for v6?
return m_host;
} else {
std::stringstream p;
if (m_ipv6_literal) {
p << "[" << m_host << "]:" << m_port;
} else {
p << m_host << ":" << m_port;
}
return p.str();
}
}
std::string get_authority() const {
std::stringstream p;
if (m_ipv6_literal) {
p << "[" << m_host << "]:" << m_port;
} else {
p << m_host << ":" << m_port;
}
return p.str();
}
uint16_t get_port() const {
return m_port;
}
std::string get_port_str() const {
std::stringstream p;
p << m_port;
return p.str();
}
std::string const & get_resource() const {
return m_resource;
}
std::string str() const {
std::stringstream s;
s << m_scheme << "://";
if (m_ipv6_literal) {
s << "[" << m_host << "]";
} else {
s << m_host;
}
if (m_port != (m_secure ? uri_default_secure_port : uri_default_port)) {
s << ":" << m_port;
}
s << m_resource;
return s.str();
}
/// Return the query portion
/**
* Returns the query portion (after the ?) of the URI or an empty string if
* there is none.
*
* @return query portion of the URI.
*/
std::string get_query() const {
std::size_t found = m_resource.find('?');
if (found != std::string::npos) {
return m_resource.substr(found + 1);
} else {
return "";
}
}
// get fragment
// hi <3
// get the string representation of this URI
//std::string base() const; // is this still needed?
// setter methods set some or all (in the case of parse) based on the input.
// These functions throw a uri_exception on failure.
/*void set_uri(const std::string& uri);
void set_secure(bool secure);
void set_host(const std::string& host);
void set_port(uint16_t port);
void set_port(const std::string& port);
void set_resource(const std::string& resource);*/
private:
uint16_t get_port_from_string(std::string const & port, lib::error_code &
ec) const
{
ec = lib::error_code();
if (port.empty()) {
return (m_secure ? uri_default_secure_port : uri_default_port);
}
unsigned int t_port = static_cast<unsigned int>(atoi(port.c_str()));
if (t_port > 65535) {
ec = error::make_error_code(error::invalid_port);
}
if (t_port == 0) {
ec = error::make_error_code(error::invalid_port);
}
return static_cast<uint16_t>(t_port);
}
std::string m_scheme;
std::string m_host;
std::string m_resource;
uint16_t m_port;
bool m_secure;
bool m_valid;
bool m_ipv6_literal;
};
/// Pointer to a URI
typedef lib::shared_ptr<uri> uri_ptr;
} // namespace websocketpp
#endif // WEBSOCKETPP_URI_HPP
_WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
Definition boost_config.hpp:41
_WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_THREAD_
Definition boost_config.hpp:61
_WEBSOCKETPP_CPP11_MEMORY_
#define _WEBSOCKETPP_CPP11_MEMORY_
Definition boost_config.hpp:40
_WEBSOCKETPP_CPP11_SYSTEM_ERROR_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
Definition boost_config.hpp:57
broadcast_server
Definition simple_broadcast_server.cpp:13
websocketpp::concurrency::basic
Concurrency policy that uses std::mutex / boost::mutex.
Definition basic.hpp:37
websocketpp::connection_base
Stub for user supplied base class.
Definition connection_base.hpp:34
websocketpp::endpoint_base
Stub for user supplied base class.
Definition endpoint_base.hpp:34
websocketpp::extensions::permessage_deflate::disabled
Stub class for use when disabling permessage_deflate extension.
Definition disabled.hpp:53
websocketpp::http::parser::request
Stores, parses, and manipulates HTTP requests.
Definition request.hpp:50
websocketpp::http::parser::response
Stores, parses, and manipulates HTTP responses.
Definition response.hpp:57
websocketpp::log::basic
Basic logger that outputs to an ostream.
Definition basic.hpp:59
websocketpp::message_buffer::alloc::con_msg_manager
Definition alloc.hpp:43
websocketpp::message_buffer::alloc::endpoint_msg_manager
Definition alloc.hpp:88
websocketpp::random::none::int_generator
Thread safe stub "random" integer generator.
Definition none.hpp:46
websocketpp::server
Server endpoint role based on the given config.
Definition server_endpoint.hpp:44
websocketpp::transport::asio::basic_socket::endpoint
Basic ASIO endpoint socket component.
Definition none.hpp:318
websocketpp::transport::asio::endpoint
Asio based endpoint transport component.
Definition endpoint.hpp:54
websocketpp::transport::error::category
Definition connection.hpp:183
websocketpp::transport::iostream::connection
Definition connection.hpp:60
websocketpp::transport::iostream::connection::ptr
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
Definition connection.hpp:65
websocketpp::transport::iostream::connection::get_handle
connection_hdl get_handle() const
Get the connection handle.
Definition connection.hpp:313
websocketpp::transport::iostream::connection::alog_type
config::alog_type alog_type
Type of this transport's access logging policy.
Definition connection.hpp:70
websocketpp::transport::iostream::connection::dispatch
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present).
Definition connection.hpp:580
websocketpp::transport::iostream::connection::set_uri
void set_uri(uri_ptr)
Set uri hook.
Definition connection.hpp:121
websocketpp::transport::iostream::connection::async_shutdown
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
Definition connection.hpp:593
websocketpp::transport::iostream::connection::set_write_handler
void set_write_handler(write_handler h)
Sets the write handler.
Definition connection.hpp:350
websocketpp::transport::iostream::connection::set_secure
void set_secure(bool value)
Set whether or not this connection is secure.
Definition connection.hpp:257
websocketpp::transport::iostream::connection::set_shutdown_handler
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition connection.hpp:400
websocketpp::transport::iostream::connection::type
connection< config > type
Type of this connection transport component.
Definition connection.hpp:63
websocketpp::transport::iostream::connection::elog_type
config::elog_type elog_type
Type of this transport's error logging policy.
Definition connection.hpp:72
websocketpp::transport::iostream::connection::fatal_error
void fatal_error()
Signal transport error.
Definition connection.hpp:235
websocketpp::transport::iostream::connection::read_some
size_t read_some(char const *buf, size_t len)
Manual input supply (read some).
Definition connection.hpp:165
websocketpp::transport::iostream::connection::read_all
size_t read_all(char const *buf, size_t len)
Manual input supply (read all).
Definition connection.hpp:188
websocketpp::transport::iostream::connection::async_write
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
Definition connection.hpp:487
websocketpp::transport::iostream::connection::readsome
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED).
Definition connection.hpp:208
websocketpp::transport::iostream::connection::concurrency_type
config::concurrency_type concurrency_type
transport concurrency policy
Definition connection.hpp:68
websocketpp::transport::iostream::connection::init
void init(init_handler handler)
Initialize the connection transport.
Definition connection.hpp:410
websocketpp::transport::iostream::connection::set_timer
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
Definition connection.hpp:327
websocketpp::transport::iostream::connection::eof
void eof()
Signal EOF.
Definition connection.hpp:219
websocketpp::transport::iostream::connection::operator>>
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
Definition connection.hpp:142
websocketpp::transport::iostream::connection::set_vector_write_handler
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
Definition connection.hpp:380
websocketpp::transport::iostream::connection::is_secure
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition connection.hpp:271
websocketpp::transport::iostream::connection::get_remote_endpoint
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
Definition connection.hpp:305
websocketpp::transport::iostream::connection::set_handle
void set_handle(connection_hdl hdl)
Set Connection Handle.
Definition connection.hpp:565
websocketpp::transport::iostream::connection::register_ostream
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
Definition connection.hpp:104
websocketpp::transport::iostream::connection::async_read_at_least
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.
Definition connection.hpp:439
websocketpp::transport::iostream::connection::async_write
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather).
Definition connection.hpp:527
websocketpp::transport::iostream::connection::get_shared
ptr get_shared()
Get a shared pointer to this component.
Definition connection.hpp:93
websocketpp::transport::iostream::endpoint
Definition endpoint.hpp:46
websocketpp::transport::iostream::endpoint::transport_con_type
iostream::connection< config > transport_con_type
Definition endpoint.hpp:62
websocketpp::transport::iostream::endpoint::elog_type
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition endpoint.hpp:56
websocketpp::transport::iostream::endpoint::set_write_handler
void set_write_handler(write_handler h)
Sets the write handler.
Definition endpoint.hpp:134
websocketpp::transport::iostream::endpoint::set_shutdown_handler
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition endpoint.hpp:154
websocketpp::transport::iostream::endpoint::is_secure
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition endpoint.hpp:116
websocketpp::transport::iostream::endpoint::ptr
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition endpoint.hpp:51
websocketpp::transport::iostream::endpoint::transport_con_ptr
transport_con_type::ptr transport_con_ptr
Definition endpoint.hpp:65
websocketpp::transport::iostream::endpoint::async_connect
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition endpoint.hpp:183
websocketpp::transport::iostream::endpoint::init
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition endpoint.hpp:197
websocketpp::transport::iostream::endpoint::init_logging
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition endpoint.hpp:171
websocketpp::transport::iostream::endpoint::type
endpoint type
Type of this endpoint transport component.
Definition endpoint.hpp:49
websocketpp::transport::iostream::endpoint::register_ostream
void register_ostream(std::ostream *o)
Register a default output stream.
Definition endpoint.hpp:80
websocketpp::transport::iostream::endpoint::concurrency_type
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition endpoint.hpp:54
websocketpp::transport::iostream::endpoint::set_secure
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition endpoint.hpp:102
websocketpp::transport::iostream::endpoint::alog_type
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition endpoint.hpp:58
websocketpp::transport::iostream::error::category
iostream transport error category
Definition base.hpp:85
websocketpp::uri
Definition uri.hpp:397
websocketpp::uri::get_query
std::string get_query() const
Return the query portion.
Definition uri.hpp:732
websocketpp::uri::is_ipv6_literal
bool is_ipv6_literal() const
Definition uri.hpp:651
_WEBSOCKETPP_NOEXCEPT_TOKEN_
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition cpp11.hpp:115
__has_extension
#define __has_extension
Definition cpp11.hpp:40
__has_feature
#define __has_feature(x)
Definition cpp11.hpp:37
websocketpp::concurrency
Concurrency handling support.
Definition basic.hpp:34
websocketpp::error
Library level error codes.
Definition error.hpp:44
websocketpp::error::invalid_port
@ invalid_port
Invalid port in URI.
Definition error.hpp:120
websocketpp::extensions::permessage_deflate
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition disabled.hpp:44
websocketpp::extensions
Definition disabled.hpp:43
websocketpp::http
HTTP handling support.
Definition request.hpp:37
websocketpp::random::none
Stub RNG policy that always returns 0.
Definition none.hpp:35
websocketpp::random
Random number generation policies.
Definition random_device.hpp:34
websocketpp::transport::asio::basic_socket
Definition none.hpp:47
websocketpp::transport::asio
Transport policy that uses asio.
Definition endpoint.hpp:46
websocketpp::transport::error
Generic transport related errors.
Definition connection.hpp:146
websocketpp::transport::error::value
value
Definition connection.hpp:147
websocketpp::transport::error::timeout
@ timeout
Timer expired.
Definition connection.hpp:174
websocketpp::transport::error::general
@ general
Definition connection.hpp:150
websocketpp::transport::error::pass_through
@ pass_through
underlying transport pass through
Definition connection.hpp:153
websocketpp::transport::error::eof
@ eof
End of file.
Definition connection.hpp:168
websocketpp::transport::error::operation_not_supported
@ operation_not_supported
Operation not supported.
Definition connection.hpp:165
websocketpp::transport::error::operation_aborted
@ operation_aborted
Operation aborted.
Definition connection.hpp:162
websocketpp::transport::error::tls_error
@ tls_error
Other TLS error.
Definition connection.hpp:180
websocketpp::transport::error::invalid_num_bytes
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition connection.hpp:156
websocketpp::transport::error::action_after_shutdown
@ action_after_shutdown
read or write after shutdown
Definition connection.hpp:177
websocketpp::transport::error::tls_short_read
@ tls_short_read
TLS short read.
Definition connection.hpp:171
websocketpp::transport::error::double_read
@ double_read
async_read called while another async_read was in progress
Definition connection.hpp:159
websocketpp::transport::iostream::error
iostream transport errors
Definition base.hpp:64
websocketpp::transport::iostream::error::value
value
Definition base.hpp:65
websocketpp::transport::iostream::error::general
@ general
Definition base.hpp:68
websocketpp::transport::iostream::error::output_stream_required
@ output_stream_required
Definition base.hpp:78
websocketpp::transport::iostream::error::invalid_num_bytes
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition base.hpp:71
websocketpp::transport::iostream::error::double_read
@ double_read
async_read called while another async_read was in progress
Definition base.hpp:74
websocketpp::transport::iostream::error::bad_stream
@ bad_stream
stream error
Definition base.hpp:81
websocketpp::transport::iostream::error::make_error_code
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
websocketpp::transport::iostream::error::get_category
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition base.hpp:112
websocketpp::transport::iostream
Transport policy that uses STL iostream for I/O and does not support timers.
Definition endpoint.hpp:43
websocketpp::transport::iostream::vector_write_handler
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition base.hpp:57
websocketpp::transport::iostream::shutdown_handler
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition base.hpp:61
websocketpp::transport::iostream::write_handler
lib::function< lib::error_code(connection_hdl, char const *, size_t)> write_handler
The type and signature of the callback used by iostream transport to write.
Definition base.hpp:48
websocketpp::transport
Transport policies provide network connectivity and timers.
Definition endpoint.hpp:45
websocketpp::transport::read_handler
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
Definition connection.hpp:120
websocketpp::transport::dispatch_handler
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition connection.hpp:135
websocketpp::transport::interrupt_handler
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
Definition connection.hpp:132
websocketpp::transport::accept_handler
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
websocketpp::transport::timer_handler
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
Definition connection.hpp:126
websocketpp::transport::connect_handler
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
websocketpp::transport::write_handler
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
Definition connection.hpp:123
websocketpp::transport::init_handler
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
Definition connection.hpp:117
websocketpp::transport::shutdown_handler
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Definition connection.hpp:129
websocketpp::uri_helper
A group of helper methods for parsing and validating URIs against RFC 3986.
Definition uri.hpp:52
websocketpp::uri_helper::digit
bool digit(char c)
RFC3986 digit character test.
Definition uri.hpp:184
websocketpp::uri_helper::gen_delim
bool gen_delim(char c)
RFC3986 generic delimiter character test.
Definition uri.hpp:78
websocketpp::uri_helper::digit
bool digit(std::string::const_iterator it)
RFC3986 digit character test (iterator version).
Definition uri.hpp:195
websocketpp::uri_helper::ipv4_literal
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
websocketpp::uri_helper::sub_delim
bool sub_delim(char c)
RFC3986 subcomponent delimiter character test.
Definition uri.hpp:100
websocketpp::uri_helper::reg_name
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
websocketpp::uri_helper::pct_encoded
bool pct_encoded(std::string::const_iterator it)
RFC3986 per cent encoded character test.
Definition uri.hpp:211
websocketpp::uri_helper::scheme
bool scheme(char c)
RFC3986 scheme character test.
Definition uri.hpp:165
websocketpp::uri_helper::unreserved
bool unreserved(char c)
RFC3986 unreserved character test.
Definition uri.hpp:61
websocketpp::uri_helper::reg_name
bool reg_name(char c)
Tests a character for validity for a registry name.
Definition uri.hpp:361
websocketpp::uri_helper::hex4
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
websocketpp::uri_helper::dec_octet
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
websocketpp::uri_helper::ipv6_literal
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
websocketpp::uri_helper::hexdigit
bool hexdigit(char c)
RFC3986 hex digit character test.
Definition uri.hpp:128
websocketpp
Namespace for the WebSocket++ project.
Definition asio_no_tls_client.hpp:34
websocketpp::uri_default_secure_port
static uint16_t const uri_default_secure_port
Default port for wss://.
Definition uri.hpp:47
websocketpp::connection_hdl
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
Definition connection_hdl.hpp:48
websocketpp::uri_default_port
static uint16_t const uri_default_port
Default port for ws://.
Definition uri.hpp:45
websocketpp::uri_ptr
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition uri.hpp:791
is_error_code_enum< websocketpp::transport::error::value >
Definition connection.hpp:233
is_error_code_enum< websocketpp::transport::iostream::error::value >
Definition base.hpp:128
websocketpp::config::asio::transport_config
Definition asio_no_tls.hpp:56
websocketpp::config::asio
Server config with asio transport and TLS disabled.
Definition asio_no_tls.hpp:38
websocketpp::config::core::permessage_deflate_config
Extension specific settings:
Definition core.hpp:260
websocketpp::config::core::permessage_deflate_config::minimum_outgoing_window_bits
static const uint8_t minimum_outgoing_window_bits
Definition core.hpp:272
websocketpp::config::core::permessage_deflate_config::allow_disabling_context_takeover
static const bool allow_disabling_context_takeover
Definition core.hpp:265
websocketpp::config::core::transport_config
Definition core.hpp:100
websocketpp::config::core::transport_config::timeout_socket_shutdown
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition core.hpp:137
websocketpp::config::core::transport_config::timeout_connect
static const long timeout_connect
Length of time to wait for TCP connect.
Definition core.hpp:134
websocketpp::config::core::transport_config::timeout_dns_resolve
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition core.hpp:131
websocketpp::config::core::transport_config::timeout_proxy
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition core.hpp:121
websocketpp::config::core::transport_config::timeout_socket_pre_init
static const long timeout_socket_pre_init
Default timer values (in ms).
Definition core.hpp:118
websocketpp::config::core::transport_config::enable_multithreading
static bool const enable_multithreading
Definition core.hpp:110
websocketpp::config::core::transport_config::timeout_socket_post_init
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition core.hpp:128
websocketpp::config::core
Server config with iostream transport.
Definition core.hpp:68
websocketpp::config::core::rng_type
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition core.hpp:93
websocketpp::config::core::elog_level
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition core.hpp:176
websocketpp::config::core::transport_type
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition core.hpp:142
websocketpp::config::core::max_http_body_size
static const size_t max_http_body_size
Default maximum http body size.
Definition core.hpp:252
websocketpp::config::core::timeout_open_handshake
static const long timeout_open_handshake
Default timer values (in ms).
Definition core.hpp:152
websocketpp::config::core::max_message_size
static const size_t max_message_size
Default maximum message size.
Definition core.hpp:240
websocketpp::config::core::drop_on_protocol_error
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition core.hpp:213
websocketpp::config::core::timeout_close_handshake
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition core.hpp:154
websocketpp::config::core::alog_level
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition core.hpp:189
websocketpp::config::core::elog_type
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition core.hpp:88
websocketpp::config::core::timeout_pong
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition core.hpp:156
websocketpp::config::core::silent_close
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition core.hpp:228
websocketpp::config::core::enable_multithreading
static bool const enable_multithreading
Definition core.hpp:98
websocketpp::config::core::connection_read_buffer_size
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition core.hpp:204
websocketpp::config::core::enable_extensions
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition core.hpp:255
websocketpp::config::core::client_version
static const int client_version
WebSocket Protocol version to use as a client.
Definition core.hpp:164
websocketpp::log::alevel
Package of log levels for logging access events.
Definition levels.hpp:112
websocketpp::log::alevel::devel
static level const devel
Development messages (warning: very chatty).
Definition levels.hpp:141
websocketpp::log::alevel::all
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:152
websocketpp::log::elevel
Package of log levels for logging errors.
Definition levels.hpp:59
websocketpp::log::elevel::devel
static level const devel
Low level debugging information (warning: very chatty).
Definition levels.hpp:63
websocketpp::log::elevel::all
static level const all
Special aggregate value representing "all levels".
Definition levels.hpp:80
websocketpp::transport::buffer
A simple utility buffer class.
Definition connection.hpp:138
websocketpp::transport::iostream::timer
Definition connection.hpp:55
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
Definition system_error.hpp:78
_WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
Definition system_error.hpp:77