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

Abstract interface for bandwidth measurement events. More...

Inheritance diagram for mi::bridge::IClient_measure_bandwidth_callback:
Inheritance graph
[legend]

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...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x80cf9612, 0x3fd4, 0x4ed0, 0xb1, 0x63, 0xc0, 0xd9, 0x84, 0xe2, 0x6, 0xaa >
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< 0x80cf9612, 0x3fd4, 0x4ed0, 0xb1, 0x63, 0xc0, 0xd9, 0x84, 0xe2, 0x6, 0xaa >
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

Abstract interface for bandwidth measurement events.

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

Member Function Documentation

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_bytes Total number of bytes sent/received.
total_time The time that elapsed on the receiving side between receiving the beginning of the first packet and the end of the last packet.
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.
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_done The number of bytes sent/received so far.
total_bytes The total number of bytes to send/receive.