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::asio::basic_socket::connection Class Reference

Basic Asio connection socket component. More...

#include <none.hpp>

Inheritance diagram for websocketpp::transport::asio::basic_socket::connection:

Public Types

typedef connection type
 Type of this connection socket component.
 
typedef lib::shared_ptr< typeptr
 Type of a shared pointer to this connection socket component.
 
typedef lib::asio::io_service * io_service_ptr
 Type of a pointer to the Asio io_service being used.
 
typedef lib::shared_ptr
< lib::asio::io_service::strand > 
strand_ptr
 Type of a pointer to the Asio io_service strand being used.
 
typedef lib::asio::ip::tcp::socket socket_type
 Type of the ASIO socket being used.
 
typedef lib::shared_ptr
< socket_type
socket_ptr
 Type of a shared pointer to the socket being used.
 

Public Member Functions

ptr get_shared ()
 Get a shared pointer to this component.
 
bool is_secure () const
 Check whether or not this connection is secure. More...
 
void set_socket_init_handler (socket_init_handler h)
 Set the socket initialization handler. More...
 
lib::asio::ip::tcp::socket & get_socket ()
 Retrieve a pointer to the underlying socket. More...
 
lib::asio::ip::tcp::socket & get_next_layer ()
 Retrieve a pointer to the underlying socket. More...
 
lib::asio::ip::tcp::socket & get_raw_socket ()
 Retrieve a pointer to the underlying socket. More...
 
std::string get_remote_endpoint (lib::error_code &ec) const
 Get the remote endpoint address. More...
 

Protected Member Functions

lib::error_code init_asio (io_service_ptr service, strand_ptr, bool)
 Perform one time initializations. More...
 
void set_uri (uri_ptr)
 Set uri hook. More...
 
void pre_init (init_handler callback)
 Pre-initialize security policy. More...
 
void post_init (init_handler callback)
 Post-initialize security policy. More...
 
void set_handle (connection_hdl hdl)
 Sets the connection handle. More...
 
lib::asio::error_code cancel_socket ()
 Cancel all async operations on this socket. More...
 
void async_shutdown (socket::shutdown_handler h)
 
lib::error_code get_ec () const
 
template<typename ErrorCodeType >
lib::error_code translate_ec (ErrorCodeType)
 Translate any security policy specific information about an error code. More...
 
lib::error_code translate_ec (lib::error_code ec)
 

Detailed Description

Basic Asio connection socket component.

transport::asio::basic_socket::connection implements a connection socket component using Asio ip::tcp::socket.

Definition at line 58 of file none.hpp.

Member Function Documentation

lib::asio::error_code websocketpp::transport::asio::basic_socket::connection::cancel_socket ( )
inlineprotected

Cancel all async operations on this socket.

Attempts to cancel all async operations on this socket and reports any failures.

NOTE: Windows XP and earlier do not support socket cancellation.

Returns
The error that occurred, if any.

Definition at line 248 of file none.hpp.

lib::asio::ip::tcp::socket& websocketpp::transport::asio::basic_socket::connection::get_next_layer ( )
inline

Retrieve a pointer to the underlying socket.

This is used internally.

Definition at line 116 of file none.hpp.

lib::asio::ip::tcp::socket& websocketpp::transport::asio::basic_socket::connection::get_raw_socket ( )
inline

Retrieve a pointer to the underlying socket.

This is used internally. It can also be used to set socket options, etc

Definition at line 124 of file none.hpp.

std::string websocketpp::transport::asio::basic_socket::connection::get_remote_endpoint ( lib::error_code &  ec) const
inline

Get the remote endpoint address.

The iostream transport has no information about the ultimate remote endpoint. It will return the string "iostream transport". To indicate this.

TODO: allow user settable remote endpoint addresses if this seems useful

Returns
A string identifying the address of the remote endpoint

Definition at line 138 of file none.hpp.

lib::asio::ip::tcp::socket& websocketpp::transport::asio::basic_socket::connection::get_socket ( )
inline

Retrieve a pointer to the underlying socket.

This is used internally. It can also be used to set socket options, etc

Definition at line 108 of file none.hpp.

lib::error_code websocketpp::transport::asio::basic_socket::connection::init_asio ( io_service_ptr  service,
strand_ptr  ,
bool   
)
inlineprotected

Perform one time initializations.

init_asio is called once immediately after construction to initialize Asio components to the io_service

Parameters
serviceA pointer to the endpoint's io_service
strandA shared pointer to the connection's asio strand
is_serverWhether or not the endpoint is a server or not.

Definition at line 165 of file none.hpp.

bool websocketpp::transport::asio::basic_socket::connection::is_secure ( ) const
inline

Check whether or not this connection is secure.

Returns
Whether or not this connection is secure

Definition at line 88 of file none.hpp.

void websocketpp::transport::asio::basic_socket::connection::post_init ( init_handler  callback)
inlineprotected

Post-initialize security policy.

Called by the transport after all intermediate proxies have been negotiated. This gives the security policy the chance to talk with the real remote endpoint for a bit before the websocket handshake.

Parameters
callbackHandler to call back with completion information

Definition at line 224 of file none.hpp.

void websocketpp::transport::asio::basic_socket::connection::pre_init ( init_handler  callback)
inlineprotected

Pre-initialize security policy.

Called by the transport after a new connection is created to initialize the socket component of the connection. This method is not allowed to write any bytes to the wire. This initialization happens before any proxies or other intermediate wrappers are negotiated.

Parameters
callbackHandler to call back with completion information

Definition at line 205 of file none.hpp.

void websocketpp::transport::asio::basic_socket::connection::set_handle ( connection_hdl  hdl)
inlineprotected

Sets the connection handle.

The connection handle is passed to any handlers to identify the connection

Parameters
hdlThe new handle

Definition at line 235 of file none.hpp.

void websocketpp::transport::asio::basic_socket::connection::set_socket_init_handler ( socket_init_handler  h)
inline

Set the socket initialization handler.

The socket initialization handler is called after the socket object is created but before it is used. This gives the application a chance to set any Asio socket options it needs.

Parameters
hThe new socket_init_handler

Definition at line 100 of file none.hpp.

void websocketpp::transport::asio::basic_socket::connection::set_uri ( uri_ptr  )
inlineprotected

Set uri hook.

Called by the transport as a connection is being established to provide the uri being connected to to the security/socket layer.

This socket policy doesn't use the uri so it is ignored.

Since
0.6.0
Parameters
uThe uri to set

Definition at line 194 of file none.hpp.

template<typename ErrorCodeType >
lib::error_code websocketpp::transport::asio::basic_socket::connection::translate_ec ( ErrorCodeType  )
inlineprotected

Translate any security policy specific information about an error code.

Translate_ec takes an Asio error code and attempts to convert its value to an appropriate websocketpp error code. In the case that the Asio and Websocketpp error types are the same (such as using boost::asio and boost::system_error or using standalone asio and std::system_error the code will be passed through natively.

In the case of a mismatch (boost::asio with std::system_error) a translated code will be returned. The plain socket policy does not have any additional information so all such errors will be reported as the generic transport pass_through error.

Since
0.3.0
Parameters
ecThe error code to translate_ec
Returns
The translated error code

Definition at line 283 of file none.hpp.

lib::error_code websocketpp::transport::asio::basic_socket::connection::translate_ec ( lib::error_code  ec)
inlineprotected

Overload of translate_ec to catch cases where lib::error_code is the same type as lib::asio::error_code

Definition at line 290 of file none.hpp.


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