#include <endpoint.hpp>
Public Types | |
typedef endpoint | type |
Type of this endpoint transport component. More... | |
typedef lib::shared_ptr< type > | ptr |
Type of a pointer to this endpoint transport component. More... | |
typedef config::concurrency_type | concurrency_type |
Type of this endpoint's concurrency policy. More... | |
typedef config::elog_type | elog_type |
Type of this endpoint's error logging policy. More... | |
typedef config::alog_type | alog_type |
Type of this endpoint's access logging policy. More... | |
typedef debug::connection< config > | transport_con_type |
Type of this endpoint transport component's associated connection transport component. More... | |
typedef transport_con_type::ptr | transport_con_ptr |
Type of a shared pointer to this endpoint transport component's associated connection transport component. More... | |
Public Member Functions | |
endpoint () | |
void | set_secure (bool) |
Set whether or not endpoint can create secure connections. More... | |
bool | is_secure () const |
Tests whether or not the underlying transport is secure. More... | |
Protected Member Functions | |
void | init_logging (alog_type *, elog_type *) |
Initialize logging. More... | |
void | async_connect (transport_con_ptr, uri_ptr, connect_handler cb) |
Initiate a new connection. More... | |
lib::error_code | init (transport_con_ptr) |
Initialize a connection. More... | |
Definition at line 42 of file endpoint.hpp.
typedef endpoint websocketpp::transport::debug::endpoint< config >::type |
Type of this endpoint transport component.
Definition at line 45 of file endpoint.hpp.
typedef lib::shared_ptr<type> websocketpp::transport::debug::endpoint< config >::ptr |
Type of a pointer to this endpoint transport component.
Definition at line 47 of file endpoint.hpp.
typedef config::concurrency_type websocketpp::transport::debug::endpoint< config >::concurrency_type |
Type of this endpoint's concurrency policy.
Definition at line 50 of file endpoint.hpp.
typedef config::elog_type websocketpp::transport::debug::endpoint< config >::elog_type |
Type of this endpoint's error logging policy.
Definition at line 52 of file endpoint.hpp.
typedef config::alog_type websocketpp::transport::debug::endpoint< config >::alog_type |
Type of this endpoint's access logging policy.
Definition at line 54 of file endpoint.hpp.
typedef debug::connection<config> websocketpp::transport::debug::endpoint< config >::transport_con_type |
Type of this endpoint transport component's associated connection transport component.
Definition at line 58 of file endpoint.hpp.
typedef transport_con_type::ptr websocketpp::transport::debug::endpoint< config >::transport_con_ptr |
Type of a shared pointer to this endpoint transport component's associated connection transport component.
Definition at line 61 of file endpoint.hpp.
|
inlineexplicit |
Definition at line 64 of file endpoint.hpp.
|
inline |
Set whether or not endpoint can create secure connections.
TODO: docs
Setting this value only indicates whether or not the endpoint is capable of producing and managing secure connections. Connections produced by this endpoint must also be individually flagged as secure if they are.
value | Whether or not the endpoint can create secure connections. |
Definition at line 81 of file endpoint.hpp.
|
inline |
Tests whether or not the underlying transport is secure.
TODO: docs
Definition at line 89 of file endpoint.hpp.
|
inlineprotected |
Initialize logging.
The loggers are located in the main endpoint class. As such, the transport doesn't have direct access to them. This method is called by the endpoint constructor to allow shared logging from the transport component. These are raw pointers to member variables of the endpoint. In particular, they cannot be used in the transport constructor as they haven't been constructed yet, and cannot be used in the transport destructor as they will have been destroyed by then.
a | A pointer to the access logger to use. |
e | A pointer to the error logger to use. |
Definition at line 106 of file endpoint.hpp.
|
inlineprotected |
Initiate a new connection.
tcon | A pointer to the transport connection component of the connection to connect. |
u | A URI pointer to the URI to connect to. |
cb | The function to call back with the results when complete. |
Definition at line 115 of file endpoint.hpp.
|
inlineprotected |
Initialize a connection.
Init is called by an endpoint once for each newly created connection. It's purpose is to give the transport policy the chance to perform any transport specific initialization that couldn't be done via the default constructor.
tcon | A pointer to the transport portion of the connection. |
Definition at line 129 of file endpoint.hpp.