so_5::stats::controller_t Class Reference

A public interface for control SObjectizer monitoring options. More...

#include <controller.hpp>

Inheritance diagram for so_5::stats::controller_t:

Public Member Functions
virtual const mbox_t &	mbox () const =0
	Get the mbox for receiving monitoring information. More...
virtual void	turn_on ()=0
	Turn the monitoring on. More...
virtual void	turn_off ()=0
	Turn the monitoring off. More...
virtual std::chrono::steady_clock::duration	set_distribution_period (std::chrono::steady_clock::duration period)=0
	Set distribution period. More...

Protected Member Functions
	controller_t (const controller_t &)=delete
	controller_t (controller_t &&)=delete
controller_t &	operator= (const controller_t &)=delete
controller_t &	operator= (controller_t &&)=delete
	controller_t ()=default
	~controller_t ()=default

Static Protected Member Functions
static std::chrono::steady_clock::duration	default_distribution_period ()
	Default distribution period. More...

Detailed Description

A public interface for control SObjectizer monitoring options.

Since

v.5.5.4

Constructor & Destructor Documentation

controller_t() [1/3]

so_5::stats::controller_t::controller_t ( const controller_t &  )

protecteddelete

controller_t() [2/3]

so_5::stats::controller_t::controller_t ( controller_t &&  )

protecteddelete

controller_t() [3/3]

so_5::stats::controller_t::controller_t ( )

protecteddefault

~controller_t()

so_5::stats::controller_t::~controller_t ( )

protecteddefault

Member Function Documentation

default_distribution_period()

static std::chrono::steady_clock::duration so_5::stats::controller_t::default_distribution_period ( )

inlinestaticprotected

Default distribution period.

Since

v.5.5.19

mbox()

virtual const mbox_t& so_5::stats::controller_t::mbox ( ) const

pure virtual

Get the mbox for receiving monitoring information.

Implemented in so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< Lock_Holder >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::actual_lock_holder_t<> >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::no_lock_holder_t >, and so_5::stats::impl::std_controller_t.

operator=() [1/2]

controller_t& so_5::stats::controller_t::operator= ( const controller_t &  )

protecteddelete

operator=() [2/2]

controller_t& so_5::stats::controller_t::operator= ( controller_t &&  )

protecteddelete

set_distribution_period()

virtual std::chrono::steady_clock::duration so_5::stats::controller_t::set_distribution_period ( std::chrono::steady_clock::duration  period )

pure virtual

Set distribution period.

Returns

Old distribution period value.

Parameters

period

New period value.

Implemented in so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< Lock_Holder >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::actual_lock_holder_t<> >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::no_lock_holder_t >, and so_5::stats::impl::std_controller_t.

Examples:

so_5/queue_size_stats/main.cpp.

turn_off()

virtual void so_5::stats::controller_t::turn_off ( )

pure virtual

Turn the monitoring off.

Implemented in so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< Lock_Holder >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::actual_lock_holder_t<> >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::no_lock_holder_t >, and so_5::stats::impl::std_controller_t.

turn_on()

virtual void so_5::stats::controller_t::turn_on ( )

pure virtual

Turn the monitoring on.

Implemented in so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< Lock_Holder >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::actual_lock_holder_t<> >, so_5::env_infrastructures::st_reusable_stuff::stats_controller_t< so_5::details::no_lock_holder_t >, and so_5::stats::impl::std_controller_t.

Examples:

so_5/queue_size_stats/main.cpp.

---

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

• controller.hpp