tim::component::network_stats Struct Reference

#include "timemory/components/network/components.hpp"

Collaboration diagram for tim::component::network_stats:

Public Types
using	value_type = cache::network_stats
using	this_type = network_stats
using	base_type = base< this_type, value_type >
using	data_array_type = typename cache::network_stats::data_type
using	string_array_type = typename cache::network_stats::string_array_type
using	iface_map_type = std::unordered_map< std::string, string_array_type >
using	storage_type = empty_storage

Public Member Functions
	network_stats (std::string)
	network_stats (std::vector< std::string >)
	network_stats ()=default
	~network_stats ()=default
	network_stats (const network_stats &)=default
	network_stats (network_stats &&)=default
network_stats &	operator= (const network_stats &)=default
network_stats &	operator= (network_stats &&)=default
data_array_type	get () const
std::string	get_display () const
void	sample ()
void	start ()
void	stop ()

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static data_array_type	data_array (value_type)
static data_array_type	unit_array ()
static string_array_type	label_array ()
static string_array_type	display_unit_array ()
static string_array_type	description_array ()
static value_type	record (const std::string &_interface)
static value_type	record (const std::vector< std::string > &_interfaces)
static std::vector< std::string > &	get_interfaces ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Static Public Attributes
static constexpr size_t	data_size = cache::network_stats::data_size

Detailed Description

Definition at line 43 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::network_stats::base_type = base<this_type, value_type>

Definition at line 49 of file components.hpp.

data_array_type

using tim::component::network_stats::data_array_type = typename cache::network_stats::data_type

Definition at line 50 of file components.hpp.

iface_map_type

using tim::component::network_stats::iface_map_type = std::unordered_map<std::string, string_array_type>

Definition at line 52 of file components.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

string_array_type

using tim::component::network_stats::string_array_type = typename cache::network_stats::string_array_type

Definition at line 51 of file components.hpp.

this_type

using tim::component::network_stats::this_type = network_stats

Definition at line 48 of file components.hpp.

value_type

using tim::component::network_stats::value_type = cache::network_stats

Definition at line 47 of file components.hpp.

Constructor & Destructor Documentation

network_stats() [1/5]

tim::component::network_stats::network_stats ( std::string  _interface )

inline

Definition at line 126 of file components.hpp.

: m_interfaces{ std::move(_interface) }
{}

network_stats() [2/5]

tim::component::network_stats::network_stats ( std::vector< std::string >  _interfaces )

inline

Definition at line 130 of file components.hpp.

: m_interfaces{ std::move(_interfaces) }
{}

network_stats() [3/5]

tim::component::network_stats::network_stats ( )

default

~network_stats()

tim::component::network_stats::~network_stats ( )

default

network_stats() [4/5]

tim::component::network_stats::network_stats ( const network_stats &  )

default

network_stats() [5/5]

tim::component::network_stats::network_stats ( network_stats &&  )

default

Member Function Documentation

data_array()

network_stats::data_array_type tim::component::network_stats::data_array ( value_type  _data )

inlinestatic

Definition at line 261 of file components.hpp.

{
    return _data.get_data();
}

description()

std::string tim::component::network_stats::description ( )

inlinestatic

Definition at line 98 of file components.hpp.

{
    return "Reports network bytes, packets, errors, dropped";
}

description_array()

network_stats::string_array_type tim::component::network_stats::description_array ( )

inlinestatic

Definition at line 285 of file components.hpp.

{
    return cache::network_stats::data_descriptions();
}

display_unit_array()

network_stats::string_array_type tim::component::network_stats::display_unit_array ( )

inlinestatic

Definition at line 279 of file components.hpp.

{
    return cache::network_stats::data_display_units();
}

get()

network_stats::data_array_type tim::component::network_stats::get ( ) const

inline

Definition at line 188 of file components.hpp.

{
    auto _data = load();
    if(!m_first && !get_is_transient())
    {
        _data.get_data().fill(0);
        return _data.get_data();
    }
 
    static auto _data_units = cache::network_stats::data_units();
    for(size_t i = 0; i < data_size; ++i)
        _data.get_data()[i] /= _data_units[i];
    return _data.get_data();
}

References data_size, tim::component::base< network_stats, cache::network_stats >::get_is_transient(), and tim::component::base< network_stats, cache::network_stats >::load().

Referenced by get_display().

get_display()

std::string tim::component::network_stats::get_display ( ) const

inline

Definition at line 204 of file components.hpp.

{
    auto&& _get_display = [](const int64_t& _val, const std::string& _lbl,
                             const std::string& _units) {
        std::stringstream ss;
        ss.setf(base_type::get_format_flags());
        ss << std::setw(base_type::get_width())
           << std::setprecision(base_type::get_precision()) << _val;
        if(!_units.empty())
            ss << " " << _units;
        if(!_lbl.empty())
            ss << " " << _lbl;
        return ss.str();
    };
 
    auto&&            _val    = value_type{ get() };
    auto              _disp   = cache::network_stats::data_display_units();
    auto              _labels = cache::network_stats::data_labels();
    std::stringstream ss;
    for(size_t i = 0; i < data_size; ++i)
        ss << ", " << _get_display(_val.get_data()[i], _labels[i], _disp[i]);
    return ss.str().substr(2);
}

References data_size, get(), tim::component::base< Tp, Value >::get_format_flags(), tim::component::base< Tp, Value >::get_precision(), and tim::component::base< Tp, Value >::get_width().

get_interfaces()

std::vector< std::string > & tim::component::network_stats::get_interfaces ( )

inlinestatic

Definition at line 135 of file components.hpp.

{
    static std::string              _last{};
    static std::string              _value{};
    static std::vector<std::string> _instance{};
 
    auto* _settings = settings::instance();
    if(!_settings)
        return _instance;
    _settings->get(TIMEMORY_SETTINGS_KEY("NETWORK_INTERFACE"), _value, true);
 
    auto _update_instance = []() {
        _instance.clear();
        for(auto&& itr : delimit(_value, " ,\t;"))
        {
            if(itr != "." && itr != "..")
                _instance.emplace_back(std::move(itr));
        }
    };
 
    if(_instance.empty())
    {
        if(!_value.empty())
        {
            _update_instance();
            _last = _value;
        }
        else
        {
            for(auto&& itr : utility::filesystem::list_directory("/sys/class/net"))
            {
                if(itr != "." && itr != "..")
                    _instance.emplace_back(std::move(itr));
            }
            if(_instance.empty())
                return _instance;
            std::stringstream _ss;
            for(const auto& itr : _instance)
                _ss << ", " << itr;
            _value = _last = _ss.str().substr(2);
            _settings->set(TIMEMORY_SETTINGS_KEY("NETWORK_INTERFACE"), _value, true);
        }
    }
    else if(_last != _value)
    {
        _update_instance();
        _last = _value;
    }
 
    return _instance;
}

References tim::_settings, tim::delimit(), tim::argparse::argument_parser::get(), tim::settings::instance(), and tim::TIMEMORY_SETTINGS_KEY().

Referenced by start().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

label()

std::string tim::component::network_stats::label ( )

inlinestatic

Definition at line 92 of file components.hpp.

{
    return "network_stats";
}

label_array()

network_stats::string_array_type tim::component::network_stats::label_array ( )

inlinestatic

Definition at line 273 of file components.hpp.

{
    return cache::network_stats::data_labels();
}

operator=() [1/2]

network_stats & tim::component::network_stats::operator= ( const network_stats &  )

default

operator=() [2/2]

network_stats & tim::component::network_stats::operator= ( network_stats &&  )

default

record() [1/2]

network_stats::value_type tim::component::network_stats::record ( const std::string &  _interface )

inlinestatic

Definition at line 104 of file components.hpp.

{
    if(_interface.empty())
        return cache::network_stats{};
    // const auto& _iface_paths = get_iface_paths(_name);
    return cache::network_stats{ _interface };
}

Referenced by sample(), start(), and stop().

record() [2/2]

network_stats::value_type tim::component::network_stats::record ( const std::vector< std::string > &  _interfaces )

inlinestatic

Definition at line 113 of file components.hpp.

{
    if(_interfaces.empty())
        return cache::network_stats{};
    cache::network_stats _data{};
    for(const auto& itr : _interfaces)
    {
        if(!itr.empty())
            _data += cache::network_stats{ itr };
    }
    return _data;
}

sample()

void tim::component::network_stats::sample ( )

inline

Definition at line 229 of file components.hpp.

{
    if(m_first)
    {
        m_first = false;
        value   = record(m_interfaces);
    }
    else
    {
        auto _current = record(m_interfaces);
        accum += _current - value;
        value = _current;
        set_is_transient(true);
    }
}

References record(), and tim::component::base< network_stats, cache::network_stats >::set_is_transient().

start()

void tim::component::network_stats::start ( )

inline

Definition at line 246 of file components.hpp.

{
    if(m_interfaces.empty())
        m_interfaces = get_interfaces();
    value = record(m_interfaces);
}

References get_interfaces(), and record().

stop()

void tim::component::network_stats::stop ( )

inline

Definition at line 254 of file components.hpp.

{
    value = record(m_interfaces) - value;
    accum += value;
}

References record().

unit_array()

network_stats::data_array_type tim::component::network_stats::unit_array ( )

inlinestatic

Definition at line 267 of file components.hpp.

{
    return cache::network_stats::data_units();
}

Member Data Documentation

data_size

constexpr size_t tim::component::network_stats::data_size = cache::network_stats::data_size

staticconstexpr

Definition at line 45 of file components.hpp.

Referenced by get(), and get_display().

---

The documentation for this struct was generated from the following file:

• timemory/components/network/components.hpp