WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
websocketpp::transport::stub::endpoint< config > Class Template Reference

Public Types

typedef endpoint type
 Type of this endpoint transport component.
 
typedef lib::shared_ptr< typeptr
 Type of a pointer to this endpoint transport component.
 
typedef config::concurrency_type concurrency_type
 Type of this endpoint's concurrency policy.
 
typedef config::elog_type elog_type
 Type of this endpoint's error logging policy.
 
typedef config::alog_type alog_type
 Type of this endpoint's access logging policy.
 
typedef stub::connection< config > transport_con_type
 
typedef transport_con_type::ptr transport_con_ptr
 

Public Member Functions

void set_secure (bool value)
 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 *a, elog_type *e)
 Initialize logging. More...
 
void async_connect (transport_con_ptr tcon, uri_ptr u, connect_handler cb)
 Initiate a new connection. More...
 
lib::error_code init (transport_con_ptr tcon)
 Initialize a connection. More...
 

Detailed Description

template<typename config>
class websocketpp::transport::stub::endpoint< config >

Definition at line 42 of file endpoint.hpp.

Member Typedef Documentation

Type of a shared pointer to this endpoint transport component's associated connection transport component

Definition at line 61 of file endpoint.hpp.

template<typename config >
typedef stub::connection<config> websocketpp::transport::stub::endpoint< config >::transport_con_type

Type of this endpoint transport component's associated connection transport component.

Definition at line 58 of file endpoint.hpp.

Member Function Documentation

template<typename config >
void websocketpp::transport::stub::endpoint< config >::async_connect ( transport_con_ptr  tcon,
uri_ptr  u,
connect_handler  cb 
)
inlineprotected

Initiate a new connection.

Parameters
tconA pointer to the transport connection component of the connection to connect.
uA URI pointer to the URI to connect to.
cbThe function to call back with the results when complete.

Definition at line 115 of file endpoint.hpp.

template<typename config >
lib::error_code websocketpp::transport::stub::endpoint< config >::init ( transport_con_ptr  tcon)
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.

Parameters
tconA pointer to the transport portion of the connection.
Returns
A status code indicating the success or failure of the operation

Definition at line 129 of file endpoint.hpp.

template<typename config >
void websocketpp::transport::stub::endpoint< config >::init_logging ( alog_type a,
elog_type e 
)
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.

Parameters
aA pointer to the access logger to use.
eA pointer to the error logger to use.

Definition at line 106 of file endpoint.hpp.

template<typename config >
bool websocketpp::transport::stub::endpoint< config >::is_secure ( ) const
inline

Tests whether or not the underlying transport is secure.

TODO: docs

Returns
Whether or not the underlying transport is secure

Definition at line 89 of file endpoint.hpp.

template<typename config >
void websocketpp::transport::stub::endpoint< config >::set_secure ( bool  value)
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.

Since
0.3.0-alpha4
Parameters
valueWhether or not the endpoint can create secure connections.

Definition at line 81 of file endpoint.hpp.


The documentation for this class was generated from the following file: