NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::http::IWeb_socket_data_handler Class Referenceabstract

A WebSocket data handler that can be installed to a WebSocket connection to handle data arriving at the WebSocket. More...

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

Public Member Functions

virtual void  handle (IWeb_socket *web_socket, neuraylib::IBuffer *buffer)=0
  The handle() function is called when new data is received. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xbe989e2c, 0xf1e6, 0x492a, 0xb6, 0x42, 0x1f, 0xd7, 0x30, 0x1f, 0xa2, 0x9f >
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< 0xbe989e2c, 0xf1e6, 0x492a, 0xb6, 0x42, 0x1f, 0xd7, 0x30, 0x1f, 0xa2, 0x9f >
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 data handler that can be installed to a WebSocket connection to handle data arriving at the WebSocket.

After its installation, the WebSocket data handler is called when new data arrives on the connection.

Member Function Documentation

virtual void mi::http::IWeb_socket_data_handler::handle ( IWeb_socket web_socket,
neuraylib::IBuffer buffer 
)
pure virtual

The handle() function is called when new data is received.

Parameters
web_socket The WebSocket connection on which new data has arrived.
buffer A buffer containing received data.