neuray API Programmer's Manual

mi::bridge::IClient_measure_bandwidth_callback Class Reference

[Bridge client]

Description

Abstract interface for bandwidth measurement events.

See also:

mi::bridge::IClient_session::measure_bandwidth()

Public Member Functions

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

Member Functions

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.