websocketpp::transport::asio::endpoint< config > Class Template Reference

Asio based endpoint transport component. More...

#include <endpoint.hpp>

Inheritance diagram for websocketpp::transport::asio::endpoint< config >:

Collaboration diagram for websocketpp::transport::asio::endpoint< config >:

Public Types
typedef endpoint< config >	type
	Type of this endpoint transport component.
typedef config::concurrency_type	concurrency_type
	Type of the concurrency policy.
typedef config::socket_type	socket_type
	Type of the socket policy.
typedef config::elog_type	elog_type
	Type of the error logging policy.
typedef config::alog_type	alog_type
	Type of the access logging policy.
typedef socket_type::socket_con_type	socket_con_type
	Type of the socket connection component.
typedef socket_con_type::ptr	socket_con_ptr
	Type of a shared pointer to the socket connection component.
typedef asio::connection< config >	transport_con_type
typedef transport_con_type::ptr	transport_con_ptr
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::ip::tcp::acceptor >	acceptor_ptr
	Type of a shared pointer to the acceptor being used.
typedef lib::shared_ptr< lib::asio::ip::tcp::resolver >	resolver_ptr
	Type of a shared pointer to the resolver being used.
typedef lib::shared_ptr< lib::asio::steady_timer >	timer_ptr
	Type of timer handle.
typedef lib::shared_ptr< lib::asio::io_service::work >	work_ptr
	Type of a shared pointer to an io_service work object.

Public Member Functions
	endpoint ()
	~endpoint ()
bool	is_secure () const
	Return whether or not the endpoint produces secure connections.
void	init_asio (io_service_ptr ptr, lib::error_code &ec)
	initialize asio transport with external io_service (exception free)
void	init_asio (io_service_ptr ptr)
	initialize asio transport with external io_service
void	init_asio (lib::error_code &ec)
	Initialize asio transport with internal io_service (exception free)
void	init_asio ()
	Initialize asio transport with internal io_service.
void	set_tcp_pre_init_handler (tcp_init_handler h)
	Sets the tcp pre init handler.
void	set_tcp_init_handler (tcp_init_handler h)
	Sets the tcp pre init handler (deprecated)
void	set_tcp_post_init_handler (tcp_init_handler h)
	Sets the tcp post init handler.
void	set_listen_backlog (int backlog)
	Sets the maximum length of the queue of pending connections.
void	set_reuse_addr (bool value)
	Sets whether to use the SO_REUSEADDR flag when opening listening sockets.
lib::asio::io_service &	get_io_service ()
	Retrieve a reference to the endpoint's io_service.
lib::asio::ip::tcp::endpoint	get_local_endpoint (lib::asio::error_code &ec)
	Get local TCP endpoint.
void	listen (lib::asio::ip::tcp::endpoint const &ep, lib::error_code &ec)
	Set up endpoint for listening manually (exception free)
void	listen (lib::asio::ip::tcp::endpoint const &ep)
	Set up endpoint for listening manually.
template<typename InternetProtocol >
void	listen (InternetProtocol const &internet_protocol, uint16_t port, lib::error_code &ec)
	Set up endpoint for listening with protocol and port (exception free)
template<typename InternetProtocol >
void	listen (InternetProtocol const &internet_protocol, uint16_t port)
	Set up endpoint for listening with protocol and port.
void	listen (uint16_t port, lib::error_code &ec)
	Set up endpoint for listening on a port (exception free)
void	listen (uint16_t port)
	Set up endpoint for listening on a port.
void	listen (std::string const &host, std::string const &service, lib::error_code &ec)
	Set up endpoint for listening on a host and service (exception free)
void	listen (std::string const &host, std::string const &service)
	Set up endpoint for listening on a host and service.
void	stop_listening (lib::error_code &ec)
	Stop listening (exception free)
void	stop_listening ()
	Stop listening.
bool	is_listening () const
	Check if the endpoint is listening.
std::size_t	run ()
	wraps the run method of the internal io_service object
std::size_t	run_one ()
	wraps the run_one method of the internal io_service object
void	stop ()
	wraps the stop method of the internal io_service object
std::size_t	poll ()
	wraps the poll method of the internal io_service object
std::size_t	poll_one ()
	wraps the poll_one method of the internal io_service object
void	reset ()
	wraps the reset method of the internal io_service object
bool	stopped () const
	wraps the stopped method of the internal io_service object
void	start_perpetual ()
	Marks the endpoint as perpetual, stopping it from exiting when empty.
void	stop_perpetual ()
	Clears the endpoint's perpetual flag, allowing it to exit when empty.
timer_ptr	set_timer (long duration, timer_handler callback)
	Call back a function after a period of time.
void	handle_timer (timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
	Timer handler.
void	async_accept (transport_con_ptr tcon, accept_handler callback, lib::error_code &ec)
	Accept the next connection attempt and assign it to con (exception free)
void	async_accept (transport_con_ptr tcon, accept_handler callback)
	Accept the next connection attempt and assign it to con.

Protected Member Functions
void	init_logging (alog_type *a, elog_type *e)
	Initialize logging.
void	handle_accept (accept_handler callback, lib::asio::error_code const &asio_ec)
void	async_connect (transport_con_ptr tcon, uri_ptr u, connect_handler cb)
	Initiate a new connection.
void	handle_resolve_timeout (timer_ptr, connect_handler callback, lib::error_code const &ec)
	DNS resolution timeout handler.
void	handle_resolve (transport_con_ptr tcon, timer_ptr dns_timer, connect_handler callback, lib::asio::error_code const &ec, lib::asio::ip::tcp::resolver::iterator iterator)
void	handle_connect_timeout (transport_con_ptr tcon, timer_ptr, connect_handler callback, lib::error_code const &ec)
	Asio connect timeout handler.
void	handle_connect (transport_con_ptr tcon, timer_ptr con_timer, connect_handler callback, lib::asio::error_code const &ec)
lib::error_code	init (transport_con_ptr tcon)
	Initialize a connection.

Detailed Description

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

transport::asio::endpoint implements an endpoint transport component using Asio.

Definition at line 53 of file endpoint.hpp.

Member Typedef Documentation

acceptor_ptr

template<typename config >

lib::shared_ptr<lib::asio::ip::tcp::acceptor> websocketpp::transport::asio::endpoint< config >::acceptor_ptr

Definition at line 82 of file endpoint.hpp.

alog_type

template<typename config >

config::alog_type websocketpp::transport::asio::endpoint< config >::alog_type

Definition at line 65 of file endpoint.hpp.

concurrency_type

template<typename config >

config::concurrency_type websocketpp::transport::asio::endpoint< config >::concurrency_type

Definition at line 59 of file endpoint.hpp.

elog_type

template<typename config >

config::elog_type websocketpp::transport::asio::endpoint< config >::elog_type

Definition at line 63 of file endpoint.hpp.

io_service_ptr

template<typename config >

lib::asio::io_service* websocketpp::transport::asio::endpoint< config >::io_service_ptr

Definition at line 80 of file endpoint.hpp.

resolver_ptr

template<typename config >

lib::shared_ptr<lib::asio::ip::tcp::resolver> websocketpp::transport::asio::endpoint< config >::resolver_ptr

Definition at line 84 of file endpoint.hpp.

socket_con_ptr

template<typename config >

socket_con_type::ptr websocketpp::transport::asio::endpoint< config >::socket_con_ptr

Definition at line 70 of file endpoint.hpp.

socket_con_type

template<typename config >

socket_type::socket_con_type websocketpp::transport::asio::endpoint< config >::socket_con_type

Definition at line 68 of file endpoint.hpp.

socket_type

template<typename config >

config::socket_type websocketpp::transport::asio::endpoint< config >::socket_type

Definition at line 61 of file endpoint.hpp.

timer_ptr

template<typename config >

lib::shared_ptr<lib::asio::steady_timer> websocketpp::transport::asio::endpoint< config >::timer_ptr

Definition at line 86 of file endpoint.hpp.

transport_con_ptr

template<typename config >

transport_con_type::ptr websocketpp::transport::asio::endpoint< config >::transport_con_ptr

Type of a shared pointer to the connection transport component associated with this endpoint transport component

Definition at line 77 of file endpoint.hpp.

transport_con_type

template<typename config >

asio::connection<config> websocketpp::transport::asio::endpoint< config >::transport_con_type

Type of the connection transport component associated with this endpoint transport component

Definition at line 74 of file endpoint.hpp.

type

template<typename config >

endpoint<config> websocketpp::transport::asio::endpoint< config >::type

Definition at line 56 of file endpoint.hpp.

work_ptr

template<typename config >

lib::shared_ptr<lib::asio::io_service::work> websocketpp::transport::asio::endpoint< config >::work_ptr

Definition at line 88 of file endpoint.hpp.

Constructor & Destructor Documentation

endpoint()

template<typename config >

websocketpp::transport::asio::endpoint< config >::endpoint ( )

inlineexplicit

Definition at line 91 of file endpoint.hpp.

      : m_io_service(NULL)
      , m_external_io_service(false)
      , m_listen_backlog(lib::asio::socket_base::max_connections)
      , m_reuse_addr(false)
      , m_state(UNINITIALIZED)
    {
        //std::cout << "transport::asio::endpoint constructor" << std::endl;
    }

~endpoint()

template<typename config >

websocketpp::transport::asio::endpoint< config >::~endpoint ( )

inline

Definition at line 101 of file endpoint.hpp.

                {
        // clean up our io_service if we were initialized with an internal one.
 
        // Explicitly destroy local objects
        m_acceptor.reset();
        m_resolver.reset();
        m_work.reset();
        if (m_state != UNINITIALIZED && !m_external_io_service) {
            delete m_io_service;
        }
    }

Member Function Documentation

async_accept() [1/2]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::async_accept ( transport_con_ptr tcon, accept_handler callback )

inline

Parameters

tcon	The connection to accept into.
callback	The function to call when the operation is complete.

Definition at line 779 of file endpoint.hpp.

                                                                       {
        lib::error_code ec;
        async_accept(tcon,callback,ec);
        if (ec) { throw exception(ec); }
    }

Here is the call graph for this function:

async_accept() [2/2]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::async_accept ( transport_con_ptr tcon, accept_handler callback, lib::error_code & ec )

inline

Parameters

tcon	The connection to accept into.
callback	The function to call when the operation is complete.
ec	A status code indicating an error, if any.

Definition at line 740 of file endpoint.hpp.

    {
        if (m_state != LISTENING) {
            using websocketpp::error::make_error_code;
            ec = make_error_code(websocketpp::error::async_accept_not_listening);
            return;
        }
 
        m_alog->write(log::alevel::devel, "asio::async_accept");
 
        if (config::enable_multithreading) {
            m_acceptor->async_accept(
                tcon->get_raw_socket(),
                tcon->get_strand()->wrap(lib::bind(
                    &type::handle_accept,
                    this,
                    callback,
                    lib::placeholders::_1
                ))
            );
        } else {
            m_acceptor->async_accept(
                tcon->get_raw_socket(),
                lib::bind(
                    &type::handle_accept,
                    this,
                    callback,
                    lib::placeholders::_1
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

async_connect()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::async_connect ( transport_con_ptr tcon, uri_ptr u, connect_handler cb )

inlineprotected

Definition at line 821 of file endpoint.hpp.

                                                                              {
        using namespace lib::asio::ip;
 
        // Create a resolver
        if (!m_resolver) {
            m_resolver = lib::make_shared<lib::asio::ip::tcp::resolver>(*m_io_service);
        }
 
        tcon->set_uri(u);
 
        std::string proxy = tcon->get_proxy();
        std::string host;
        std::string port;
 
        if (proxy.empty()) {
            host = u->get_host();
            port = u->get_port_str();
        } else {
            lib::error_code ec;
 
            uri_ptr pu = lib::make_shared<uri>(proxy);
 
            if (!pu->get_valid()) {
                cb(make_error_code(error::proxy_invalid));
                return;
            }
 
            ec = tcon->proxy_init(u->get_authority());
            if (ec) {
                cb(ec);
                return;
            }
 
            host = pu->get_host();
            port = pu->get_port_str();
        }
 
        tcp::resolver::query query(host,port);
 
        if (m_alog->static_test(log::alevel::devel)) {
            m_alog->write(log::alevel::devel,
                "starting async DNS resolve for "+host+":"+port);
        }
 
        timer_ptr dns_timer;
 
        dns_timer = tcon->set_timer(
            config::timeout_dns_resolve,
            lib::bind(
                &type::handle_resolve_timeout,
                this,
                dns_timer,
                cb,
                lib::placeholders::_1
            )
        );
 
        if (config::enable_multithreading) {
            m_resolver->async_resolve(
                query,
                tcon->get_strand()->wrap(lib::bind(
                    &type::handle_resolve,
                    this,
                    tcon,
                    dns_timer,
                    cb,
                    lib::placeholders::_1,
                    lib::placeholders::_2
                ))
            );
        } else {
            m_resolver->async_resolve(
                query,
                lib::bind(
                    &type::handle_resolve,
                    this,
                    tcon,
                    dns_timer,
                    cb,
                    lib::placeholders::_1,
                    lib::placeholders::_2
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get_io_service()

template<typename config >

lib::asio::io_service & websocketpp::transport::asio::endpoint< config >::get_io_service ( )

inline

The io_service may be an internal or external one. This may be used to call methods of the io_service that are not explicitly wrapped by the endpoint.

This method is only valid after the endpoint has been initialized with init_asio. No error will be returned if it isn't.

Returns

A reference to the endpoint's io_service

Definition at line 356 of file endpoint.hpp.

                                         {
        return *m_io_service;
    }

get_local_endpoint()

template<typename config >

lib::asio::ip::tcp::endpoint websocketpp::transport::asio::endpoint< config >::get_local_endpoint ( lib::asio::error_code & ec )

inline

Extracts the local endpoint from the acceptor. This represents the address that WebSocket++ is listening on.

Sets a bad_descriptor error if the acceptor is not currently listening or otherwise unavailable.

Since

0.7.0

Parameters

ec	Set to indicate what error occurred, if any.

Returns

The local endpoint

Definition at line 373 of file endpoint.hpp.

                                                                    {
        if (m_acceptor) {
            return m_acceptor->local_endpoint(ec);
        } else {
            ec = lib::asio::error::make_error_code(lib::asio::error::bad_descriptor);
            return lib::asio::ip::tcp::endpoint();
        }
    }

handle_accept()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_accept ( accept_handler callback, lib::asio::error_code const & asio_ec )

inlineprotected

Definition at line 800 of file endpoint.hpp.

    {
        lib::error_code ret_ec;
 
        m_alog->write(log::alevel::devel, "asio::handle_accept");
 
        if (asio_ec) {
            if (asio_ec == lib::asio::errc::operation_canceled) {
                ret_ec = make_error_code(websocketpp::error::operation_canceled);
            } else {
                log_err(log::elevel::info,"asio handle_accept",asio_ec);
                ret_ec = asio_ec;
            }
        }
 
        callback(ret_ec);
    }

Here is the caller graph for this function:

handle_connect()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_connect ( transport_con_ptr tcon, timer_ptr con_timer, connect_handler callback, lib::asio::error_code const & ec )

inlineprotected

Definition at line 1048 of file endpoint.hpp.

    {
        if (ec == lib::asio::error::operation_aborted ||
            lib::asio::is_neg(con_timer->expires_from_now()))
        {
            m_alog->write(log::alevel::devel,"async_connect cancelled");
            return;
        }
 
        con_timer->cancel();
 
        if (ec) {
            log_err(log::elevel::info,"asio async_connect",ec);
            callback(ec);
            return;
        }
 
        if (m_alog->static_test(log::alevel::devel)) {
            m_alog->write(log::alevel::devel,
                "Async connect to "+tcon->get_remote_endpoint()+" successful.");
        }
 
        callback(lib::error_code());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handle_connect_timeout()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_connect_timeout ( transport_con_ptr tcon, timer_ptr , connect_handler callback, lib::error_code const & ec )

inlineprotected

The timer pointer is included to ensure the timer isn't destroyed until after it has expired.

Parameters

tcon	Pointer to the transport connection that is being connected
con_timer	Pointer to the timer in question
callback	The function to call back
ec	A status code indicating an error, if any.

Definition at line 1025 of file endpoint.hpp.

    {
        lib::error_code ret_ec;
 
        if (ec) {
            if (ec == transport::error::operation_aborted) {
                m_alog->write(log::alevel::devel,
                    "asio handle_connect_timeout timer cancelled");
                return;
            }
 
            log_err(log::elevel::devel,"asio handle_connect_timeout",ec);
            ret_ec = ec;
        } else {
            ret_ec = make_error_code(transport::error::timeout);
        }
 
        m_alog->write(log::alevel::devel,"TCP connect timed out");
        tcon->cancel_socket_checked();
        callback(ret_ec);
    }

Here is the caller graph for this function:

handle_resolve()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_resolve ( transport_con_ptr tcon, timer_ptr dns_timer, connect_handler callback, lib::asio::error_code const & ec, lib::asio::ip::tcp::resolver::iterator iterator )

inlineprotected

Definition at line 939 of file endpoint.hpp.

    {
        if (ec == lib::asio::error::operation_aborted ||
            lib::asio::is_neg(dns_timer->expires_from_now()))
        {
            m_alog->write(log::alevel::devel,"async_resolve cancelled");
            return;
        }
 
        dns_timer->cancel();
 
        if (ec) {
            log_err(log::elevel::info,"asio async_resolve",ec);
            callback(ec);
            return;
        }
 
        if (m_alog->static_test(log::alevel::devel)) {
            std::stringstream s;
            s << "Async DNS resolve successful. Results: ";
 
            lib::asio::ip::tcp::resolver::iterator it, end;
            for (it = iterator; it != end; ++it) {
                s << (*it).endpoint() << " ";
            }
 
            m_alog->write(log::alevel::devel,s.str());
        }
 
        m_alog->write(log::alevel::devel,"Starting async connect");
 
        timer_ptr con_timer;
 
        con_timer = tcon->set_timer(
            config::timeout_connect,
            lib::bind(
                &type::handle_connect_timeout,
                this,
                tcon,
                con_timer,
                callback,
                lib::placeholders::_1
            )
        );
 
        if (config::enable_multithreading) {
            lib::asio::async_connect(
                tcon->get_raw_socket(),
                iterator,
                tcon->get_strand()->wrap(lib::bind(
                    &type::handle_connect,
                    this,
                    tcon,
                    con_timer,
                    callback,
                    lib::placeholders::_1
                ))
            );
        } else {
            lib::asio::async_connect(
                tcon->get_raw_socket(),
                iterator,
                lib::bind(
                    &type::handle_connect,
                    this,
                    tcon,
                    con_timer,
                    callback,
                    lib::placeholders::_1
                )
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handle_resolve_timeout()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_resolve_timeout ( timer_ptr , connect_handler callback, lib::error_code const & ec )

inlineprotected

The timer pointer is included to ensure the timer isn't destroyed until after it has expired.

Parameters

dns_timer	Pointer to the timer in question
callback	The function to call back
ec	A status code indicating an error, if any.

Definition at line 916 of file endpoint.hpp.

    {
        lib::error_code ret_ec;
 
        if (ec) {
            if (ec == transport::error::operation_aborted) {
                m_alog->write(log::alevel::devel,
                    "asio handle_resolve_timeout timer cancelled");
                return;
            }
 
            log_err(log::elevel::devel,"asio handle_resolve_timeout",ec);
            ret_ec = ec;
        } else {
            ret_ec = make_error_code(transport::error::timeout);
        }
 
        m_alog->write(log::alevel::devel,"DNS resolution timed out");
        m_resolver->cancel();
        callback(ret_ec);
    }

Here is the caller graph for this function:

handle_timer()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::handle_timer ( timer_ptr , timer_handler callback, lib::asio::error_code const & ec )

inline

The timer pointer is included to ensure the timer isn't destroyed until after it has expired.

Parameters

t	Pointer to the timer in question
callback	The function to call back
ec	A status code indicating an error, if any.

Definition at line 717 of file endpoint.hpp.

    {
        if (ec) {
            if (ec == lib::asio::error::operation_aborted) {
                callback(make_error_code(transport::error::operation_aborted));
            } else {
                m_elog->write(log::elevel::info,
                    "asio handle_timer error: "+ec.message());
                log_err(log::elevel::info,"asio handle_timer",ec);
                callback(ec);
            }
        } else {
            callback(lib::error_code());
        }
    }

Here is the caller graph for this function:

init()

template<typename config >

lib::error_code websocketpp::transport::asio::endpoint< config >::init ( transport_con_ptr tcon )

inlineprotected

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

tcon	A pointer to the transport portion of the connection.

Returns

A status code indicating the success or failure of the operation

Definition at line 1085 of file endpoint.hpp.

                                               {
        m_alog->write(log::alevel::devel, "transport::asio::init");
 
        // Initialize the connection socket component
        socket_type::init(lib::static_pointer_cast<socket_con_type,
            transport_con_type>(tcon));
 
        lib::error_code ec;
 
        ec = tcon->init_asio(m_io_service);
        if (ec) {return ec;}
 
        tcon->set_tcp_pre_init_handler(m_tcp_pre_init_handler);
        tcon->set_tcp_post_init_handler(m_tcp_post_init_handler);
 
        return lib::error_code();
    }

Here is the caller graph for this function:

init_asio() [1/4]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::init_asio ( )

inline

This method of initialization will allocate and use an internally managed io_service.

See also

init_asio(io_service_ptr ptr)

Definition at line 245 of file endpoint.hpp.

                     {
        // Use a smart pointer until the call is successful and ownership has 
        // successfully been taken. Use unique_ptr when available.
        // TODO: remove the use of auto_ptr when C++98/03 support is no longer
        //       necessary.
#ifdef _WEBSOCKETPP_CPP11_MEMORY_
        lib::unique_ptr<lib::asio::io_service> service(new lib::asio::io_service());
#else
        lib::auto_ptr<lib::asio::io_service> service(new lib::asio::io_service());
#endif
        init_asio( service.get() );
        // If control got this far without an exception, then ownership has successfully been taken
        service.release();
        m_external_io_service = false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

init_asio() [2/4]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::init_asio ( io_service_ptr ptr )

inline

Initialize the ASIO transport policy for this endpoint using the provided io_service object. asio_init must be called exactly once on any endpoint that uses transport::asio before it can be used.

Parameters

ptr	A pointer to the io_service to use for asio events

Definition at line 208 of file endpoint.hpp.

                                       {
        lib::error_code ec;
        init_asio(ptr,ec);
        if (ec) { throw exception(ec); }
    }

Here is the call graph for this function:

init_asio() [3/4]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::init_asio ( io_service_ptr ptr, lib::error_code & ec )

inline

Initialize the ASIO transport policy for this endpoint using the provided io_service object. asio_init must be called exactly once on any endpoint that uses transport::asio before it can be used.

Parameters

ptr	A pointer to the io_service to use for asio events
ec	Set to indicate what error occurred, if any.

Definition at line 181 of file endpoint.hpp.

                                                           {
        if (m_state != UNINITIALIZED) {
            m_elog->write(log::elevel::library,
                "asio::init_asio called from the wrong state");
            using websocketpp::error::make_error_code;
            ec = make_error_code(websocketpp::error::invalid_state);
            return;
        }
 
        m_alog->write(log::alevel::devel,"asio::init_asio");
 
        m_io_service = ptr;
        m_external_io_service = true;
        m_acceptor = lib::make_shared<lib::asio::ip::tcp::acceptor>(*m_io_service);
 
        m_state = READY;
        ec = lib::error_code();
    }

Here is the call graph for this function:

init_asio() [4/4]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::init_asio ( lib::error_code & ec )

inline

This method of initialization will allocate and use an internally managed io_service.

See also

init_asio(io_service_ptr ptr)

Parameters

ec	Set to indicate what error occurred, if any.

Definition at line 223 of file endpoint.hpp.

                                       {
        // Use a smart pointer until the call is successful and ownership has 
        // successfully been taken. Use unique_ptr when available.
        // TODO: remove the use of auto_ptr when C++98/03 support is no longer
        //       necessary.
#ifdef _WEBSOCKETPP_CPP11_MEMORY_
        lib::unique_ptr<lib::asio::io_service> service(new lib::asio::io_service());
#else
        lib::auto_ptr<lib::asio::io_service> service(new lib::asio::io_service());
#endif
        init_asio(service.get(), ec);
        if( !ec ) service.release(); // Call was successful, transfer ownership
        m_external_io_service = false;
    }

Here is the call graph for this function:

init_logging()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::init_logging ( alog_type * a, elog_type * e )

inlineprotected

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.

Definition at line 795 of file endpoint.hpp.

                                                  {
        m_alog = a;
        m_elog = e;
    }

Here is the caller graph for this function:

is_listening()

template<typename config >

bool websocketpp::transport::asio::endpoint< config >::is_listening ( ) const

inline

Returns

Whether or not the endpoint is listening.

Definition at line 607 of file endpoint.hpp.

                              {
        return (m_state == LISTENING);
    }

is_secure()

template<typename config >

bool websocketpp::transport::asio::endpoint< config >::is_secure ( ) const

inline

Definition at line 168 of file endpoint.hpp.

                           {
        return socket_type::is_secure();
    }

listen() [1/8]

template<typename config >

template<typename InternetProtocol >

void websocketpp::transport::asio::endpoint< config >::listen ( InternetProtocol const & internet_protocol, uint16_t port )

inline

Bind the internal acceptor using the given internet protocol and port. The endpoint must have been initialized by calling init_asio before listening.

Common options include:

• IPv6 with mapped IPv4 for dual stack hosts lib::asio::ip::tcp::v6()
• IPv4 only: lib::asio::ip::tcp::v4()

Parameters

internet_protocol	The internet protocol to use.
port	The port to listen on.

Definition at line 474 of file endpoint.hpp.

    {
        lib::asio::ip::tcp::endpoint ep(internet_protocol, port);
        listen(ep);
    }

Here is the call graph for this function:

listen() [2/8]

template<typename config >

template<typename InternetProtocol >

void websocketpp::transport::asio::endpoint< config >::listen ( InternetProtocol const & internet_protocol, uint16_t port, lib::error_code & ec )

inline

Bind the internal acceptor using the given internet protocol and port. The endpoint must have been initialized by calling init_asio before listening.

Common options include:

• IPv6 with mapped IPv4 for dual stack hosts lib::asio::ip::tcp::v6()
• IPv4 only: lib::asio::ip::tcp::v4()

Parameters

internet_protocol	The internet protocol to use.
port	The port to listen on.
ec	Set to indicate what error occurred, if any.

Definition at line 453 of file endpoint.hpp.

    {
        lib::asio::ip::tcp::endpoint ep(internet_protocol, port);
        listen(ep,ec);
    }

Here is the call graph for this function:

listen() [3/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( lib::asio::ip::tcp::endpoint< config > const & ep )

inline

Bind the internal acceptor using the settings specified by the endpoint e

Parameters

ep	An endpoint to read settings from

Definition at line 432 of file endpoint.hpp.

                                                 {
        lib::error_code ec;
        listen(ep,ec);
        if (ec) { throw exception(ec); }
    }

Here is the call graph for this function:

listen() [4/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( lib::asio::ip::tcp::endpoint< config > const & ep, lib::error_code & ec )

inline

Bind the internal acceptor using the specified settings. The endpoint must have been initialized by calling init_asio before listening.

Parameters

ep	An endpoint to read settings from
ec	Set to indicate what error occurred, if any.

Definition at line 390 of file endpoint.hpp.

    {
        if (m_state != READY) {
            m_elog->write(log::elevel::library,
                "asio::listen called from the wrong state");
            using websocketpp::error::make_error_code;
            ec = make_error_code(websocketpp::error::invalid_state);
            return;
        }
 
        m_alog->write(log::alevel::devel,"asio::listen");
 
        lib::asio::error_code bec;
 
        m_acceptor->open(ep.protocol(),bec);
        if (!bec) {
            m_acceptor->set_option(lib::asio::socket_base::reuse_address(m_reuse_addr),bec);
        }
        if (!bec) {
            m_acceptor->bind(ep,bec);
        }
        if (!bec) {
            m_acceptor->listen(m_listen_backlog,bec);
        }
        if (bec) {
            if (m_acceptor->is_open()) {
                m_acceptor->close();
            }
            log_err(log::elevel::info,"asio listen",bec);
            ec = bec;//make_error_code(error::pass_through);
        } else {
            m_state = LISTENING;
            ec = lib::error_code();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listen() [5/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( std::string const & host, std::string const & service )

inline

Bind the internal acceptor using the given host and service. More details about what host and service can be are available in the Asio documentation for ip::basic_resolver_query::basic_resolver_query's constructors.

The endpoint must have been initialized by calling init_asio before listening.

Parameters

host	A string identifying a location. May be a descriptive name or a numeric address string.
service	A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.
ec	Set to indicate what error occurred, if any.

Definition at line 561 of file endpoint.hpp.

    {
        lib::error_code ec;
        listen(host,service,ec);
        if (ec) { throw exception(ec); }
    }

Here is the call graph for this function:

listen() [6/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( std::string const & host, std::string const & service, lib::error_code & ec )

inline

Bind the internal acceptor using the given host and service. More details about what host and service can be are available in the Asio documentation for ip::basic_resolver_query::basic_resolver_query's constructors.

The endpoint must have been initialized by calling init_asio before listening.

Parameters

host	A string identifying a location. May be a descriptive name or a numeric address string.
service	A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.
ec	Set to indicate what error occurred, if any.

Definition at line 528 of file endpoint.hpp.

    {
        using lib::asio::ip::tcp;
        tcp::resolver r(*m_io_service);
        tcp::resolver::query query(host, service);
        tcp::resolver::iterator endpoint_iterator = r.resolve(query);
        tcp::resolver::iterator end;
        if (endpoint_iterator == end) {
            m_elog->write(log::elevel::library,
                "asio::listen could not resolve the supplied host or service");
            ec = make_error_code(error::invalid_host_service);
            return;
        }
        listen(*endpoint_iterator,ec);
    }

Here is the call graph for this function:

listen() [7/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( uint16_t port )

inline

Bind the internal acceptor using the given port. The IPv6 protocol with mapped IPv4 for dual stack hosts will be used. If you need IPv4 only use the overload that allows specifying the protocol explicitly.

The endpoint must have been initialized by calling init_asio before listening.

Parameters

port	The port to listen on.
ec	Set to indicate what error occurred, if any.

Definition at line 508 of file endpoint.hpp.

                               {
        listen(lib::asio::ip::tcp::v6(), port);
    }

Here is the call graph for this function:

listen() [8/8]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::listen ( uint16_t port, lib::error_code & ec )

inline

Bind the internal acceptor using the given port. The IPv6 protocol with mapped IPv4 for dual stack hosts will be used. If you need IPv4 only use the overload that allows specifying the protocol explicitly.

The endpoint must have been initialized by calling init_asio before listening.

Parameters

port	The port to listen on.
ec	Set to indicate what error occurred, if any.

Definition at line 492 of file endpoint.hpp.

                                                   {
        listen(lib::asio::ip::tcp::v6(), port, ec);
    }

Here is the call graph for this function:

poll()

template<typename config >

std::size_t websocketpp::transport::asio::endpoint< config >::poll ( )

inline

Definition at line 630 of file endpoint.hpp.

                     {
        return m_io_service->poll();
    }

poll_one()

template<typename config >

std::size_t websocketpp::transport::asio::endpoint< config >::poll_one ( )

inline

Definition at line 635 of file endpoint.hpp.

                         {
        return m_io_service->poll_one();
    }

reset()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::reset ( )

inline

Definition at line 640 of file endpoint.hpp.

                 {
        m_io_service->reset();
    }

run()

template<typename config >

std::size_t websocketpp::transport::asio::endpoint< config >::run ( )

inline

Definition at line 612 of file endpoint.hpp.

                    {
        return m_io_service->run();
    }

Here is the caller graph for this function:

run_one()

template<typename config >

std::size_t websocketpp::transport::asio::endpoint< config >::run_one ( )

inline

Since

0.3.0-alpha4

Definition at line 620 of file endpoint.hpp.

                        {
        return m_io_service->run_one();
    }

set_listen_backlog()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::set_listen_backlog ( int backlog )

inline

Sets the maximum length of the queue of pending connections. Increasing this will allow WebSocket++ to queue additional incoming connections. Setting it higher may prevent failed connections at high connection rates but may cause additional latency.

For this value to take effect you may need to adjust operating system settings.

New values affect future calls to listen only.

A value of zero will use the operating system default. This is the default value.

Since

0.3.0

Parameters

backlog

The maximum length of the queue of pending connections

Definition at line 323 of file endpoint.hpp.

                                         {
        m_listen_backlog = backlog;
    }

set_reuse_addr()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::set_reuse_addr ( bool value )

inline

Specifies whether or not to use the SO_REUSEADDR TCP socket option. What this flag does depends on your operating system. Please consult operating system documentation for more details.

New values affect future calls to listen only.

The default is false.

Since

0.3.0

Parameters

value

Whether or not to use the SO_REUSEADDR option

Definition at line 341 of file endpoint.hpp.

                                    {
        m_reuse_addr = value;
    }

set_tcp_init_handler()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::set_tcp_init_handler ( tcp_init_handler h )

inline

The tcp pre init handler is called after the raw tcp connection has been established but before any additional wrappers (proxy connects, TLS handshakes, etc) have been performed.

Deprecated

Use set_tcp_pre_init_handler instead

Parameters

h	The handler to call on tcp pre init.

Definition at line 285 of file endpoint.hpp.

                                                  {
        set_tcp_pre_init_handler(h);
    }

Here is the call graph for this function:

set_tcp_post_init_handler()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::set_tcp_post_init_handler ( tcp_init_handler h )

inline

The tcp post init handler is called after the tcp connection has been established and all additional wrappers (proxy connects, TLS handshakes, etc have been performed. This is fired before any bytes are read or any WebSocket specific handshake logic has been performed.

Since

0.3.0

Parameters

h	The handler to call on tcp post init.

Definition at line 300 of file endpoint.hpp.

                                                       {
        m_tcp_post_init_handler = h;
    }

set_tcp_pre_init_handler()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::set_tcp_pre_init_handler ( tcp_init_handler h )

inline

The tcp pre init handler is called after the raw tcp connection has been established but before any additional wrappers (proxy connects, TLS handshakes, etc) have been performed.

Since

0.3.0

Parameters

h	The handler to call on tcp pre init.

Definition at line 271 of file endpoint.hpp.

                                                      {
        m_tcp_pre_init_handler = h;
    }

Here is the caller graph for this function:

set_timer()

template<typename config >

timer_ptr websocketpp::transport::asio::endpoint< config >::set_timer ( long duration, timer_handler callback )

inline

Sets a timer that calls back a function after the specified period of milliseconds. Returns a handle that can be used to cancel the timer. A cancelled timer will return the error code error::operation_aborted A timer that expired will return no error.

Parameters

duration	Length of time to wait in milliseconds
callback	The function to call back when the timer has expired

Returns

A handle that can be used to cancel the timer if it is no longer needed.

Definition at line 689 of file endpoint.hpp.

                                                               {
        timer_ptr new_timer = lib::make_shared<lib::asio::steady_timer>(
            *m_io_service,
             lib::asio::milliseconds(duration)
        );
 
        new_timer->async_wait(
            lib::bind(
                &type::handle_timer,
                this,
                new_timer,
                callback,
                lib::placeholders::_1
            )
        );
 
        return new_timer;
    }

Here is the call graph for this function:

start_perpetual()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::start_perpetual ( )

inline

Marks the endpoint as perpetual. Perpetual endpoints will not automatically exit when they run out of connections to process. To stop a perpetual endpoint call end_perpetual.

An endpoint may be marked perpetual at any time by any thread. It must be called either before the endpoint has run out of work or before it was started

Since

0.3.0

Definition at line 661 of file endpoint.hpp.

                           {
        m_work = lib::make_shared<lib::asio::io_service::work>(*m_io_service);
    }

stop()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::stop ( )

inline

Definition at line 625 of file endpoint.hpp.

                {
        m_io_service->stop();
    }

stop_listening() [1/2]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::stop_listening ( )

inline

Stop listening and accepting new connections. This will not end any existing connections.

Since

0.3.0-alpha4

Definition at line 597 of file endpoint.hpp.

                          {
        lib::error_code ec;
        stop_listening(ec);
        if (ec) { throw exception(ec); }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stop_listening() [2/2]

template<typename config >

void websocketpp::transport::asio::endpoint< config >::stop_listening ( lib::error_code & ec )

inline

Stop listening and accepting new connections. This will not end any existing connections.

Since

0.3.0-alpha4

Parameters

ec	A status code indicating an error, if any.

Definition at line 576 of file endpoint.hpp.

                                            {
        if (m_state != LISTENING) {
            m_elog->write(log::elevel::library,
                "asio::listen called from the wrong state");
            using websocketpp::error::make_error_code;
            ec = make_error_code(websocketpp::error::invalid_state);
            return;
        }
 
        m_acceptor->close();
        m_state = READY;
        ec = lib::error_code();
    }

Here is the call graph for this function:

stop_perpetual()

template<typename config >

void websocketpp::transport::asio::endpoint< config >::stop_perpetual ( )

inline

Clears the endpoint's perpetual flag. This will cause the endpoint's run method to exit normally when it runs out of connections. If there are currently active connections it will not end until they are complete.

Since

0.3.0

Definition at line 673 of file endpoint.hpp.

                          {
        m_work.reset();
    }

stopped()

template<typename config >

bool websocketpp::transport::asio::endpoint< config >::stopped ( ) const

inline

Definition at line 645 of file endpoint.hpp.

                         {
        return m_io_service->stopped();
    }

---

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

• libraries/fc/vendor/websocketpp/websocketpp/transport/asio/base.hpp
• libraries/fc/vendor/websocketpp/websocketpp/transport/asio/endpoint.hpp