DiCE API nvidia_logo_transpbg.gif Up
mi::http::IWeb_socket_handler Class Referenceabstract

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

#include <http.h>

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...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xb784d27c, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xb784d27c, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. 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

 handle()

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_socketThe WebSocket on which the request came in.
Returns
true, if the request was completely handled, or false otherwise.