neuray API Programmer's Manual

mi::neuraylib::INetwork_statistics Class Reference

[Configuration Interfaces]

Description

This interface is used to inquire statistics about the network usage etc.

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual Uint64 get_calculated_send_bandwidth( Uint32 host_id = 0) const =0
Returns the calculated send bandwidth towards a given host. More...
virtual Uint64 get_current_send_bandwidth( Uint32 host_id = 0) const =0
Returns the actual send bandwidth towards a given host. More...
virtual Float64 get_last_seen( Uint32 host_id) const =0
Returns the last time a given host was seen. More...
virtual Float64 get_loss_rate( Uint32 host_id = 0) const =0
Returns the current loss rate towards a given host. More...
virtual Uint64 get_nr_of_nacked_packets( Uint32 host_id = 0) const =0
Returns the number of packets for which a NACK was received for this host. More...
virtual Uint64 get_rdma_received_bytes() const =0
Returns the total number of bytes received as RDMA.
virtual Uint64 get_rdma_sent_bytes() const =0
Returns the total number of bytes sent as RDMA.
virtual Uint64 get_received_bytes() const =0
Returns the total number of bytes received so far.
virtual Uint64 get_sent_bytes() const =0
Returns the total number of bytes sent so far.

Member Functions

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_calculated_send_bandwidth( Uint32 host_id = 0) const [pure virtual]

Returns the calculated send bandwidth towards a given host.

Parameters

host_id
The host in question, or 0 for multicast.

Returns

The calculated send bandwidth in bits per second.

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_current_send_bandwidth( Uint32 host_id = 0) const [pure virtual]

Returns the actual send bandwidth towards a given host.

Parameters

host_id
The host in question, or 0 for multicast.

Returns

The actual send bandwidth in bits per second.

virtual Float64 mi::​neuraylib::​INetwork_statistics::get_last_seen( Uint32 host_id) const [pure virtual]

Returns the last time a given host was seen.

Parameters

host_id
The host in question.

Returns

The time that passed since the host was seen last (in seconds).

virtual Float64 mi::​neuraylib::​INetwork_statistics::get_loss_rate( Uint32 host_id = 0) const [pure virtual]

Returns the current loss rate towards a given host.

Parameters

host_id
The host in question, or 0 for multicast.

Returns

The current loss rate (ratio between lost and all packets).

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_nr_of_nacked_packets( Uint32 host_id = 0) const [pure virtual]

Returns the number of packets for which a NACK was received for this host.

Parameters

host_id
The host in question, or 0 for multicast.

Returns

The number of packets for which a NACK was received.

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_rdma_received_bytes() const [pure virtual]

Returns the total number of bytes received as RDMA.

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_rdma_sent_bytes() const [pure virtual]

Returns the total number of bytes sent as RDMA.

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_received_bytes() const [pure virtual]

Returns the total number of bytes received so far.

virtual Uint64 mi::​neuraylib::​INetwork_statistics::get_sent_bytes() const [pure virtual]

Returns the total number of bytes sent so far.