Asio based endpoint transport component. More...

#include <local_endpoint.hpp>

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

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

Public Types
typedef local_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::local::stream_protocol::acceptor >	acceptor_ptr
	Type of a shared pointer to the acceptor 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
	local_endpoint ()

	~local_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	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.

lib::asio::io_service &	get_io_service ()
	Retrieve a reference to the endpoint's io_service.

void	listen (lib::asio::local::stream_protocol::endpoint const &ep, lib::error_code &ec)
	Set up endpoint for listening manually (exception free)

void	listen (lib::asio::local::stream_protocol::endpoint const &ep)
	Set up endpoint for listening manually.

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	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::local_endpoint< config >

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

Definition at line 159 of file local_endpoint.hpp.

Member Typedef Documentation

◆ acceptor_ptr

template<typename config >

lib::shared_ptr<lib::asio::local::stream_protocol::acceptor> websocketpp::transport::asio::local_endpoint< config >::acceptor_ptr

Definition at line 188 of file local_endpoint.hpp.

◆ alog_type

template<typename config >

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

Definition at line 171 of file local_endpoint.hpp.

◆ concurrency_type

template<typename config >

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

Definition at line 165 of file local_endpoint.hpp.

◆ elog_type

template<typename config >

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

Definition at line 169 of file local_endpoint.hpp.

◆ io_service_ptr

template<typename config >

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

Definition at line 186 of file local_endpoint.hpp.

◆ socket_con_ptr

template<typename config >

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

Definition at line 176 of file local_endpoint.hpp.

◆ socket_con_type

template<typename config >

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

Definition at line 174 of file local_endpoint.hpp.

◆ socket_type

template<typename config >

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

Definition at line 167 of file local_endpoint.hpp.

◆ timer_ptr

template<typename config >

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

Definition at line 190 of file local_endpoint.hpp.

◆ transport_con_ptr

template<typename config >

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

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

Definition at line 183 of file local_endpoint.hpp.

◆ transport_con_type

template<typename config >

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

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

Definition at line 180 of file local_endpoint.hpp.

◆ type

template<typename config >

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

Definition at line 162 of file local_endpoint.hpp.

◆ work_ptr

template<typename config >

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

Definition at line 192 of file local_endpoint.hpp.

Constructor & Destructor Documentation

◆ local_endpoint()

template<typename config >

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

inlineexplicit

Definition at line 195 of file local_endpoint.hpp.

      : m_io_service(NULL)
      , m_state(UNINITIALIZED)
    {
        //std::cout << "transport::asio::endpoint constructor" << std::endl;
    }

◆ ~local_endpoint()

template<typename config >

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

inline

Definition at line 202 of file local_endpoint.hpp.

                      {
        if (m_acceptor && m_state == LISTENING)
            ::unlink(m_acceptor->local_endpoint().path().c_str());
 
        // Explicitly destroy local objects
        m_acceptor.reset();
        m_work.reset();
    }

Member Function Documentation

◆ async_accept() [1/2]

template<typename config >

void websocketpp::transport::asio::local_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 630 of file local_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::local_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 591 of file local_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:

◆ get_io_service()

template<typename config >

lib::asio::io_service & websocketpp::transport::asio::local_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 342 of file local_endpoint.hpp.

                                         {
        return *m_io_service;
    }

Here is the caller graph for this function:

◆ handle_accept()

template<typename config >

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

inlineprotected

Definition at line 651 of file local_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::local_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 703 of file local_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:

◆ handle_connect_timeout()

template<typename config >

void websocketpp::transport::asio::local_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 680 of file local_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);
    }

◆ handle_timer()

template<typename config >

void websocketpp::transport::asio::local_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 568 of file local_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::local_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 740 of file local_endpoint.hpp.

                                               {
        m_alog->write(log::alevel::devel, "transport::asio::init");
 
        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();
    }

◆ init_asio() [1/2]

template<typename config >

void websocketpp::transport::asio::local_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 282 of file local_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() [2/2]

template<typename config >

void websocketpp::transport::asio::local_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 256 of file local_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_acceptor = lib::make_shared<lib::asio::local::stream_protocol::acceptor>(*m_io_service);
 
        m_state = READY;
        ec = lib::error_code();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_logging()

template<typename config >

void websocketpp::transport::asio::local_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 646 of file local_endpoint.hpp.

                                                  {
        m_alog = a;
        m_elog = e;
    }

◆ is_listening()

template<typename config >

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

inline

Returns: Whether or not the endpoint is listening.

Definition at line 456 of file local_endpoint.hpp.

                              {
        return (m_state == LISTENING);
    }

◆ is_secure()

template<typename config >

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

inline

Definition at line 243 of file local_endpoint.hpp.

                           {
        return socket_type::is_secure();
    }

◆ listen() [1/2]

template<typename config >

void websocketpp::transport::asio::local_endpoint< config >::listen ( lib::asio::local::stream_protocol::endpoint 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 410 of file local_endpoint.hpp.

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

Here is the call graph for this function:

◆ listen() [2/2]

template<typename config >

void websocketpp::transport::asio::local_endpoint< config >::listen	(	lib::asio::local::stream_protocol::endpoint 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 354 of file local_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;
 
        {
            boost::system::error_code test_ec;
            lib::asio::local::stream_protocol::socket test_socket(get_io_service());
            test_socket.connect(ep, test_ec);
 
            //looks like a service is already running on that socket, probably another kiod, don't touch it
            if(test_ec == boost::system::errc::success)
               bec = boost::system::errc::make_error_code(boost::system::errc::address_in_use);
            //socket exists but no one home, go ahead and remove it and continue on
            else if(test_ec == boost::system::errc::connection_refused)
               ::unlink(ep.path().c_str());
            else if(test_ec != boost::system::errc::no_such_file_or_directory)
               bec = test_ec;
        }
 
        if (!bec) {
            m_acceptor->open(ep.protocol(),bec);
        }
        if (!bec) {
            m_acceptor->bind(ep,bec);
        }
        if (!bec) {
            m_acceptor->listen(boost::asio::socket_base::max_listen_connections,bec);
        }
        if (bec) {
            if (m_acceptor->is_open()) {
                m_acceptor->close();
            }
            log_err(log::elevel::info,"asio listen",bec);
            ec = bec;
        } else {
            m_state = LISTENING;
            ec = lib::error_code();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ poll()

template<typename config >

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

inline

Definition at line 479 of file local_endpoint.hpp.

                     {
        return m_io_service->poll();
    }

◆ poll_one()

template<typename config >

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

inline

Definition at line 484 of file local_endpoint.hpp.

                         {
        return m_io_service->poll_one();
    }

◆ reset()

template<typename config >

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

inline

Definition at line 489 of file local_endpoint.hpp.

                 {
        m_io_service->reset();
    }

◆ run()

template<typename config >

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

inline

Definition at line 461 of file local_endpoint.hpp.

                    {
        return m_io_service->run();
    }

◆ run_one()

template<typename config >

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

inline

Since: 0.3.0-alpha4

Definition at line 469 of file local_endpoint.hpp.

                        {
        return m_io_service->run_one();
    }

◆ set_tcp_init_handler()

template<typename config >

void websocketpp::transport::asio::local_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 312 of file local_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::local_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 327 of file local_endpoint.hpp.

                                                       {
        m_tcp_post_init_handler = h;
    }

◆ set_tcp_pre_init_handler()

template<typename config >

void websocketpp::transport::asio::local_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 298 of file local_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::local_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 540 of file local_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::local_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 510 of file local_endpoint.hpp.

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

◆ stop()

template<typename config >

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

inline

Definition at line 474 of file local_endpoint.hpp.

                {
        m_io_service->stop();
    }

◆ stop_listening() [1/2]

template<typename config >

void websocketpp::transport::asio::local_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 446 of file local_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::local_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 424 of file local_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;
        }
 
        ::unlink(m_acceptor->local_endpoint().path().c_str());
        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::local_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 524 of file local_endpoint.hpp.

                          {
        m_work.reset();
    }

◆ stopped()

template<typename config >

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

inline

Definition at line 494 of file local_endpoint.hpp.

                         {
        return m_io_service->stopped();
    }

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

plugins/http_plugin/include/sysio/http_plugin/local_endpoint.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ acceptor_ptr

◆ alog_type

◆ concurrency_type

◆ elog_type

◆ io_service_ptr

◆ socket_con_ptr

◆ socket_con_type

◆ socket_type

◆ timer_ptr

◆ transport_con_ptr

◆ transport_con_type

◆ type

◆ work_ptr

Constructor & Destructor Documentation

◆ local_endpoint()

◆ ~local_endpoint()

Member Function Documentation

◆ async_accept() [1/2]

◆ async_accept() [2/2]

◆ get_io_service()

◆ handle_accept()

◆ handle_connect()

◆ handle_connect_timeout()

◆ handle_timer()

◆ init()

◆ init_asio() [1/2]

◆ init_asio() [2/2]

◆ init_logging()

◆ is_listening()

◆ is_secure()

◆ listen() [1/2]

◆ listen() [2/2]

◆ poll()

◆ poll_one()

◆ reset()

◆ run()

◆ run_one()

◆ set_tcp_init_handler()

◆ set_tcp_post_init_handler()

◆ set_tcp_pre_init_handler()

◆ set_timer()

◆ start_perpetual()

◆ stop()

◆ stop_listening() [1/2]

◆ stop_listening() [2/2]

◆ stop_perpetual()

◆ stopped()