websocketpp::server< config > Class Template Reference

Server endpoint role based on the given config. More...

#include <server_endpoint.hpp>

Inheritance diagram for websocketpp::server< config >:

Public Types
typedef server< config >	type
	Type of this endpoint.
typedef config::concurrency_type	concurrency_type
	Type of the endpoint concurrency component.
typedef config::transport_type	transport_type
	Type of the endpoint transport component.
typedef connection< config >	connection_type
	Type of the connections this server will create.
typedef connection_type::ptr	connection_ptr
	Type of a shared pointer to the connections this server will create.
typedef transport_type::transport_con_type	transport_con_type
	Type of the connection transport component.
typedef transport_con_type::ptr	transport_con_ptr
	Type of a shared pointer to the connection transport component.
typedef endpoint < connection_type, config >	endpoint_type
	Type of the endpoint component of this server.
Public Types inherited from websocketpp::endpoint< connection< config >, config >
typedef endpoint< connection < config >, config >	type
typedef config::transport_type	transport_type
	Type of the transport component of this endpoint.
typedef config::concurrency_type	concurrency_type
	Type of the concurrency component of this endpoint.
typedef connection< config >	connection_type
	Type of the connections that this endpoint creates.
typedef connection_type::ptr	connection_ptr
	Shared pointer to connection_type.
typedef connection_type::weak_ptr	connection_weak_ptr
	Weak pointer to connection type.
typedef transport_type::transport_con_type	transport_con_type
typedef transport_con_type::ptr	transport_con_ptr
typedef connection_type::message_handler	message_handler
	Type of message_handler.
typedef connection_type::message_ptr	message_ptr
	Type of message pointers that this endpoint uses.
typedef config::elog_type	elog_type
	Type of error logger.
typedef config::alog_type	alog_type
	Type of access logger.
typedef concurrency_type::scoped_lock_type	scoped_lock_type
	Type of our concurrency policy's scoped lock object.
typedef concurrency_type::mutex_type	mutex_type
	Type of our concurrency policy's mutex object.
typedef config::rng_type	rng_type
	Type of RNG.
typedef connection_type::termination_handler	termination_handler
typedef lib::shared_ptr < connection_weak_ptr >	hdl_type

Public Member Functions
connection_ptr	get_connection ()
	Create and initialize a new connection. More...
void	start_accept (lib::error_code &ec)
	Starts the server's async connection acceptance loop (exception free) More...
void	start_accept ()
	Starts the server's async connection acceptance loop. More...
void	handle_accept (connection_ptr con, lib::error_code const &ec)
	Handler callback for start_accept.
Public Member Functions inherited from websocketpp::endpoint< connection< config >, config >
	endpoint (bool p_is_server)
std::string	get_user_agent () const
	Returns the user agent string that this endpoint will use. More...
void	set_user_agent (std::string const &ua)
	Sets the user agent string that this endpoint will use. More...
bool	is_server () const
	Returns whether or not this endpoint is a server. More...
void	set_access_channels (log::level channels)
	Set Access logging channel. More...
void	clear_access_channels (log::level channels)
	Clear Access logging channels. More...
void	set_error_channels (log::level channels)
	Set Error logging channel. More...
void	clear_error_channels (log::level channels)
	Clear Error logging channels. More...
alog_type &	get_alog ()
	Get reference to access logger. More...
elog_type &	get_elog ()
	Get reference to error logger. More...
void	set_open_handler (open_handler h)
void	set_close_handler (close_handler h)
void	set_fail_handler (fail_handler h)
void	set_ping_handler (ping_handler h)
void	set_pong_handler (pong_handler h)
void	set_pong_timeout_handler (pong_timeout_handler h)
void	set_interrupt_handler (interrupt_handler h)
void	set_http_handler (http_handler h)
void	set_validate_handler (validate_handler h)
void	set_message_handler (message_handler h)
void	set_open_handshake_timeout (long dur)
	Set open handshake timeout. More...
void	set_close_handshake_timeout (long dur)
	Set close handshake timeout. More...
void	set_pong_timeout (long dur)
	Set pong timeout. More...
size_t	get_max_message_size () const
	Get default maximum message size. More...
void	set_max_message_size (size_t new_value)
	Set default maximum message size. More...
void	interrupt (connection_hdl hdl, lib::error_code &ec)
void	interrupt (connection_hdl hdl)
void	pause_reading (connection_hdl hdl, lib::error_code &ec)
	Pause reading of new data (exception free) More...
void	pause_reading (connection_hdl hdl)
	Pause reading of new data.
void	resume_reading (connection_hdl hdl, lib::error_code &ec)
	Resume reading of new data (exception free) More...
void	resume_reading (connection_hdl hdl)
	Resume reading of new data.
void	send (connection_hdl hdl, std::string const &payload, frame::opcode::value op, lib::error_code &ec)
	Create a message and add it to the outgoing send queue (exception free) More...
void	send (connection_hdl hdl, std::string const &payload, frame::opcode::value op)
	Create a message and add it to the outgoing send queue. More...
void	send (connection_hdl hdl, void const *payload, size_t len, frame::opcode::value op, lib::error_code &ec)
void	send (connection_hdl hdl, void const *payload, size_t len, frame::opcode::value op)
void	send (connection_hdl hdl, message_ptr msg, lib::error_code &ec)
void	send (connection_hdl hdl, message_ptr msg)
void	close (connection_hdl hdl, close::status::value const code, std::string const &reason, lib::error_code &ec)
void	close (connection_hdl hdl, close::status::value const code, std::string const &reason)
void	ping (connection_hdl hdl, std::string const &payload, lib::error_code &ec)
	Send a ping to a specific connection. More...
void	ping (connection_hdl hdl, std::string const &payload)
	Send a ping to a specific connection. More...
void	pong (connection_hdl hdl, std::string const &payload, lib::error_code &ec)
	Send a pong to a specific connection. More...
void	pong (connection_hdl hdl, std::string const &payload)
	Send a pong to a specific connection. More...
connection_ptr	get_con_from_hdl (connection_hdl hdl, lib::error_code &ec)
	Retrieves a connection_ptr from a connection_hdl (exception free) More...
connection_ptr	get_con_from_hdl (connection_hdl hdl)
	Retrieves a connection_ptr from a connection_hdl (exception version)

Additional Inherited Members
Protected Member Functions inherited from websocketpp::endpoint< connection< config >, config >
connection_ptr	create_connection ()
Protected Attributes inherited from websocketpp::endpoint< connection< config >, config >
alog_type	m_alog
elog_type	m_elog

Detailed Description

template<typename config>
class websocketpp::server< config >

Server endpoint role based on the given config.

Definition at line 44 of file server_endpoint.hpp.

Member Function Documentation

template<typename config >

connection_ptr websocketpp::server< config >::get_connection ( )

inline

Create and initialize a new connection.

The connection will be initialized and ready to begin. Call its start() method to begin the processing loop.

Note: The connection must either be started or terminated using connection::terminate in order to avoid memory leaks.

Returns

A pointer to the new connection.

Definition at line 82 of file server_endpoint.hpp.

template<typename config >

void websocketpp::server< config >::start_accept ( lib::error_code &  ec )

inline

Starts the server's async connection acceptance loop (exception free)

Initiates the server connection acceptance loop. Must be called after listen. This method will have no effect until the underlying io_service starts running. It may be called after the io_service is already running.

Refer to documentation for the transport policy you are using for instructions on how to stop this acceptance loop.

Parameters

[out]

ec

A status code indicating an error, if any.

Definition at line 97 of file server_endpoint.hpp.

template<typename config >

void websocketpp::server< config >::start_accept ( )

inline

Starts the server's async connection acceptance loop.

Initiates the server connection acceptance loop. Must be called after listen. This method will have no effect until the underlying io_service starts running. It may be called after the io_service is already running.

Refer to documentation for the transport policy you are using for instructions on how to stop this acceptance loop.

Definition at line 128 of file server_endpoint.hpp.

---

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

• websocketpp/roles/server_endpoint.hpp