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

A WebSocket state handler that can be installed to a WebSocket connection to handle events of the WebSocket. More...

#include <http.h>

Inheritance diagram for mi::http::IWeb_socket_state_handler:

Public Member Functions

virtual void handle (IWeb_socket *web_socket)=0
 The handle() function is called when the WebSocket changes its state. 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< 0x70ad6206, ... >
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< 0x70ad6206, ... >
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

A WebSocket state handler that can be installed to a WebSocket connection to handle events of the WebSocket.

After its installation, the WebSocket state handler is called whenever the WebSocket changes its state. The WebSocket state handler can query the WebSocket's state by calling mi::http::IWeb_socket::get_state().

Member Function Documentation

 handle()

virtual void mi::http::IWeb_socket_state_handler::handle ( IWeb_socket web_socket)
pure virtual

The handle() function is called when the WebSocket changes its state.

Parameters
web_socketThe WebSocket connection whose state changes.