ossia::net::websocket_server_interface Class Reference

Inheritance diagram for ossia::net::websocket_server_interface:

Detailed Description

Abstract interface for a WebSocket + HTTP server.

Both plain beast and Socket.IO server implementations derive from this interface.

Public Member Functions
virtual void	listen (uint16_t port)=0
virtual void	run ()=0
virtual void	stop ()=0
virtual void	close (ws_connection_handle hdl)=0
virtual void	set_open_handler (ws_open_handler)=0
virtual void	set_close_handler (ws_close_handler)=0
virtual void	set_message_handler (ws_server_message_handler)=0
virtual std::string	get_remote_ip (const ws_connection_handle &hdl)=0
	Get the remote IP address of a connected client (e.g. "192.168.1.10").
virtual std::string	get_remote_endpoint (const ws_connection_handle &hdl)=0
	Get the remote endpoint string (e.g. "192.168.1.10:54321").
virtual std::string	get_local_ip (const ws_connection_handle &hdl)=0
	Get the local IP address as seen by a connected client.
virtual void	send_message (ws_connection_handle hdl, const std::string &message)=0
virtual void	send_message (ws_connection_handle hdl, const server_reply &message)=0
virtual void	send_message (ws_connection_handle hdl, const rapidjson::StringBuffer &message)=0
virtual void	send_binary_message (ws_connection_handle hdl, std::string_view message)=0

Member Function Documentation

set_message_handler()

virtual void ossia::net::websocket_server_interface::set_message_handler ( ws_server_message_handler  )

pure virtual

The message handler is called for both WebSocket messages and HTTP requests. For HTTP requests, the opcode is ws_opcode::text and the payload is the URI. The returned server_reply is sent back to the client.

Implemented in ossia::net::websocket_server_beast, and ossia::net::socketio_server.

get_remote_ip()

virtual std::string ossia::net::websocket_server_interface::get_remote_ip ( const ws_connection_handle &  hdl )

pure virtual

Get the remote IP address of a connected client (e.g. "192.168.1.10").

Implemented in ossia::net::websocket_server_beast, and ossia::net::socketio_server.

get_remote_endpoint()

virtual std::string ossia::net::websocket_server_interface::get_remote_endpoint ( const ws_connection_handle &  hdl )

pure virtual

Get the remote endpoint string (e.g. "192.168.1.10:54321").

Implemented in ossia::net::websocket_server_beast, and ossia::net::socketio_server.

get_local_ip()

virtual std::string ossia::net::websocket_server_interface::get_local_ip ( const ws_connection_handle &  hdl )

pure virtual

Get the local IP address as seen by a connected client.

Implemented in ossia::net::websocket_server_beast, and ossia::net::socketio_server.