Represents an active WebSocket connection. More...

Public Member Functions
	WebSocketConnection (server::Connection &underlying_connection, bool enable_deflate=false)

	~WebSocketConnection ()

void	on_message (std::function< void(const std::string &)> handler)
	Registers a callback to be called when a message is received.

void	on_close (std::function< void()> handler)
	Registers a callback to be called when the connection is closed.

void	send (const std::string &message)
	Sends a text message over the WebSocket connection.

void	close ()
	Closes the WebSocket connection gracefully.

void	process_raw_data (std::vector< char > &buffer)

Detailed Description

Represents an active WebSocket connection.

Examples: /home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

Constructor & Destructor Documentation

http::websocket::WebSocketConnection::WebSocketConnection	(	server::Connection &	underlying_connection,
		bool	enable_deflate = `false`
	)

explicit

http::websocket::WebSocketConnection::~WebSocketConnection ( )

void http::websocket::WebSocketConnection::close ( )

Closes the WebSocket connection gracefully.

void http::websocket::WebSocketConnection::on_close ( std::function< void()> handler )

Registers a callback to be called when the connection is closed.

Parameters

handler The callback function.

void http::websocket::WebSocketConnection::on_message ( std::function< void(const std::string &)> handler )

Registers a callback to be called when a message is received.

Parameters

handler The callback function.

void http::websocket::WebSocketConnection::process_raw_data ( std::vector< char > & buffer )

void http::websocket::WebSocketConnection::send ( const std::string & message )

Sends a text message over the WebSocket connection.

Parameters

message The message to send.

Examples: /home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

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