mi::http::IWeb_socket_handler Class Reference

WebSocket handlers are responsible for handling WebSocket requests. More...

Inheritance diagram for mi::http::IWeb_socket_handler:

Public Member Functions
virtual bool	handle (IWeb_socket *web_socket)=0
	Handles an incoming WebSocket request. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0xb784d27c, 0x3b80, 0x432e, 0x89, 0xa0, 0x13, 0xe7, 0x33, 0x04, 0x82, 0x5c >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >	Self
	Own type. More...
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0xb784d27c, 0x3b80, 0x432e, 0x89, 0xa0, 0x13, 0xe7, 0x33, 0x04, 0x82, 0x5c >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

WebSocket handlers are responsible for handling WebSocket requests.

For every request the handlers are asked if they are responsible for the request. They will be asked in the order they where added. If the handle() function of a handler returns true the subsequent handlers will not be asked anymore.

See Also

mi::http::IServer::install( IWeb_socket_handler*), mi::http::IServer::remove( IWeb_socket_handler*)

Member Function Documentation

virtual bool mi::http::IWeb_socket_handler::handle ( IWeb_socket *  web_socket)

pure virtual

Handles an incoming WebSocket request.

Returns true, if the request was completely handled, i.e., no more handlers should be called. Returns false, if the request was not completely handled, i.e., subsequent handlers should be called.

Parameters

web_socket

The WebSocket on which the request came in.

Returns

true, if the request was completely handled, or false otherwise.