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

A data handler may be added to a connection. More...

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

Public Member Functions

virtual IBuffer handle (IConnection *connection, IBuffer *buffer)=0
  Handles data. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x723054d8, 0xdfa7, 0x4475, 0xbc, 0xb4, 0x44, 0x23, 0x25, 0xea, 0x52, 0x50 >
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< 0x723054d8, 0xdfa7, 0x4475, 0xbc, 0xb4, 0x44, 0x23, 0x25, 0xea, 0x52, 0x50 >
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 data handler may be added to a connection.

It is called every time data is enqueued or printed to the connection. The buffer is passed through all installed data handlers which might replace the buffer by a different buffer. If a data handler returns NULL no data is printed or enqueued to the connection and the handler is uninstalled and released.

Member Function Documentation

virtual IBuffer* mi::http::IData_handler::handle ( IConnection connection,
IBuffer buffer 
)
pure virtual

Handles data.

The method might change the buffer (by returning a new buffer instance).

Parameters
connection The connection to which the data handler belongs.
buffer The original buffer.
Returns
The new, modified buffer (or buffer if there was no modification).