DiCE API nvidia_logo_transpbg.gif Up
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...

#include <http.h>

Inheritance diagram for mi::http::IWeb_socket_data_handler:

Public Member Functions

virtual void handle (IWeb_socket *web_socket, neuraylib::IBuffer *buffer, bool binary_frame)=0
 The handle() function is called when new data is received. 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< 0xbe989e2c, ... >
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< 0xbe989e2c, ... >
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 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

 handle()

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

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

Parameters
web_socketThe WebSocket connection on which new data has arrived.
bufferA buffer containing received data.
binary_frameIndicates whether this data buffer is binary or text.