Iray SDK API nvidia_logo_transpbg.gif Up
mi::bridge::IClient_measure_bandwidth_callback Class Referenceabstract

Abstract interface for bandwidth measurement events. More...

#include <ibridge_client.h>

Inheritance diagram for mi::bridge::IClient_measure_bandwidth_callback:

Public Member Functions

virtual void progress_callback (Size bytes_done, Size total_bytes)=0
 This method is called when the bandwidth measurement starts and then when there is progress. More...
 
virtual void done_callback (Size total_bytes, Float64 total_time)=0
 This method is called when the bandwidth measurement is done. More...
 
virtual void error_callback (Sint32 error_code)=0
 This method is called if there is an error preventing the test from finishing. 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< 0x80cf9612, ... >
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< 0x80cf9612, ... >
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

Abstract interface for bandwidth measurement events.

See also
mi::bridge::IClient_session::measure_bandwidth()

Member Function Documentation

 done_callback()

virtual void mi::bridge::IClient_measure_bandwidth_callback::done_callback ( Size  total_bytes,
Float64  total_time 
)
pure virtual

This method is called when the bandwidth measurement is done.

Parameters
total_bytesTotal number of bytes sent/received.
total_timeThe time that elapsed on the receiving side between receiving the beginning of the first packet and the end of the last packet.

 error_callback()

virtual void mi::bridge::IClient_measure_bandwidth_callback::error_callback ( Sint32  error_code)
pure virtual

This method is called if there is an error preventing the test from finishing.

Parameters
error_code
  • -1: Network error.
  • <= -2: Unspecified error.

 progress_callback()

virtual void mi::bridge::IClient_measure_bandwidth_callback::progress_callback ( Size  bytes_done,
Size  total_bytes 
)
pure virtual

This method is called when the bandwidth measurement starts and then when there is progress.

Parameters
bytes_doneThe number of bytes sent/received so far.
total_bytesThe total number of bytes to send/receive.