DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::INetwork_statistics Class Referenceabstract

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

#include <inetwork_statistics.h>

Inheritance diagram for mi::neuraylib::INetwork_statistics:

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_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 Float64 get_last_seen (Uint32 host_id) const =0
 Returns the last time a given host was seen. More...
 
virtual Uint64 get_received_bytes () const =0
 Returns the total number of bytes received so far. More...
 
virtual Uint64 get_sent_bytes () const =0
 Returns the total number of bytes sent so far. More...
 
virtual Uint64 get_rdma_sent_bytes () const =0
 Returns the total number of bytes sent as RDMA. More...
 
virtual Uint64 get_rdma_received_bytes () const =0
 Returns the total number of bytes received as RDMA. 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< 0xf3706973, ... >
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< 0xf3706973, ... >
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

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

Member Function Documentation

 get_calculated_send_bandwidth()

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_idThe host in question, or 0 for multicast.
Returns
The calculated send bandwidth in bits per second.

 get_current_send_bandwidth()

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_idThe host in question, or 0 for multicast.
Returns
The actual send bandwidth in bits per second.

 get_last_seen()

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_idThe host in question.
Returns
The time that passed since the host was seen last (in seconds).

 get_loss_rate()

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_idThe host in question, or 0 for multicast.
Returns
The current loss rate (ratio between lost and all packets).

 get_nr_of_nacked_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_idThe host in question, or 0 for multicast.
Returns
The number of packets for which a NACK was received.

 get_rdma_received_bytes()

virtual Uint64 mi::neuraylib::INetwork_statistics::get_rdma_received_bytes ( ) const
pure virtual

Returns the total number of bytes received as RDMA.

 get_rdma_sent_bytes()

virtual Uint64 mi::neuraylib::INetwork_statistics::get_rdma_sent_bytes ( ) const
pure virtual

Returns the total number of bytes sent as RDMA.

 get_received_bytes()

virtual Uint64 mi::neuraylib::INetwork_statistics::get_received_bytes ( ) const
pure virtual

Returns the total number of bytes received so far.

 get_sent_bytes()

virtual Uint64 mi::neuraylib::INetwork_statistics::get_sent_bytes ( ) const
pure virtual

Returns the total number of bytes sent so far.