The websocket upgrader class, upgrade from an HTTP session to a non-secure websocket session. More...

Inheritance diagram for web::WsUpgrader< HandlerType >:

Collaboration diagram for web::WsUpgrader< HandlerType >:

Public Member Functions
	WsUpgrader (boost::beast::tcp_stream &&stream, std::string ip, std::reference_wrapper< util::TagDecoratorFactory const > tagFactory, std::reference_wrapper< dosguard::DOSGuardInterface > dosGuard, std::shared_ptr< HandlerType > const &handler, boost::beast::flat_buffer &&buffer, http::request< http::string_body > request, bool isAdmin, std::uint32_t maxWsSendingQueueSize)
	Create a new upgrader to non-secure websocket.
void	run ()
	Initiate the upgrade.

Detailed Description

template<SomeServerHandler HandlerType>
class web::WsUpgrader< HandlerType >

The websocket upgrader class, upgrade from an HTTP session to a non-secure websocket session.

Pass the socket to the session class after upgrade.

Constructor & Destructor Documentation

template<SomeServerHandler HandlerType>

web::WsUpgrader< HandlerType >::WsUpgrader	(	boost::beast::tcp_stream &&	stream,
		std::string	ip,
		std::reference_wrapper< util::TagDecoratorFactory const >	tagFactory,
		std::reference_wrapper< dosguard::DOSGuardInterface >	dosGuard,
		std::shared_ptr< HandlerType > const &	handler,
		boost::beast::flat_buffer &&	buffer,
		http::request< http::string_body >	request,
		bool	isAdmin,
		std::uint32_t	maxWsSendingQueueSize )

inline

Create a new upgrader to non-secure websocket.

Parameters

stream	The TCP stream. Ownership is transferred
ip	Client's IP address
tagFactory	A factory that is used to generate tags to track requests and sessions
dosGuard	The denial of service guard to use
handler	The server handler to use
buffer	Buffer with initial data received from the peer. Ownership is transferred
request	The request. Ownership is transferred
isAdmin	Whether the connection has admin privileges
maxWsSendingQueueSize	The maximum size of the sending queue for websocket

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