NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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...

Inheritance diagram for mi::http::IWeb_socket_state_handler:
Inheritance graph
[legend]

Public Member Functions

virtual void  handle (IWeb_socket *web_socket)=0
  The handle() function is called when the WebSocket changes its state. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x70ad6206, 0x38f0, 0x4f2a, 0xb7, 0x5d, 0x8f, 0x90, 0x64, 0x3e, 0xd0, 0x06 >
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< 0x70ad6206, 0x38f0, 0x4f2a, 0xb7, 0x5d, 0x8f, 0x90, 0x64, 0x3e, 0xd0, 0x06 >
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

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

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_socket The WebSocket connection whose state changes.