Класс PIDiagnostics

Connection quality diagnostics. Подробнее...

Граф наследования:PIDiagnostics:

Классы
struct	State
	Information about current diagnostics state. Подробнее...

Открытые типы
enum	Quality {   Unknown = 1 , Failure = 2 , Bad = 3 , Average = 4 ,   Good = 5 }
	Connection quality. Подробнее...

Открытые члены
	PIDiagnostics (bool start_=true)
	Constructs an empty diagnostics and if "start_" start it.
PIDiagnostics::State	state () const
	Returns current state.
PISystemTime	disconnectTimeout () const
	Returns period of full disconnect in seconds and period of averaging frequency.
void	setDisconnectTimeout (float s) DEPRECATEDM("use setDisconnectTimeout(PISystemTime)")
	Returns period of full disconnect in seconds and period of averaging frequency.
void	setDisconnectTimeout (PISystemTime tm)
	Returns period of full disconnect and period of averaging frequency.
PIDiagnostics::Quality	quality () const
	Returns connection quality.
PIString	receiveSpeed () const
	Returns receive speed in format "n {B|kB|MB|GB|TB}/s".
PIString	sendSpeed () const
	Returns send speed in format "n {B|kB|MB|GB|TB}/s".
Открытые члены унаследованные от PITimer
	PITimer ()
	Создает таймер
	PITimer (std::function< void(int)> func)
	Создает таймер с функцией void(int)
	PITimer (std::function< void()> func)
	Создает таймер с функцией void()
PISystemTime	interval () const
	Возвращает задержку цикла таймера
void	setInterval (PISystemTime interval)
	Установить интервал таймера
bool	isRunning () const
	Возвращает работает ли таймер
bool	isStopping () const
	Возвращает останавливается ли таймер
bool	waitForFinish (PISystemTime timeout={})
	Ожидает остановки таймера
bool	start (PISystemTime interval)
	Запустить таймер с интервалом "interval".
bool	start (PISystemTime interval, std::function< void()> func)
	Запустить таймер с интервалом "interval" и вызываевымым методом "func".
void	stopAndWait (int timeout_ms)
	Останавливает таймер и ожидает завершения.
void	stopAndWait (PISystemTime timeout={})
	Останавливает таймер и ожидает завершения.
void	setSlot (std::function< void()> func)
	Установить вызываемый метод
void	setSlot (std::function< void(int)> func)
	Установить вызываемый метод
bool	isCallQueuedEvents () const
	Возвращает должен ли таймер вызывать maybeCallQueuedEvents() каждый тик. По умолчанию true.
void	setCallQueuedEvents (bool yes)
	Установает должен ли таймер вызывать maybeCallQueuedEvents() каждый тик
void	addDelimiter (int delim, std::function< void(int)> func=nullptr)
	Добавляет делитель частоты "delim" с необязательным методом "slot".
void	addDelimiter (int delim, std::function< void()> func)
	Добавляет делитель частоты "delim" с необязательным методом "slot".
void	addDelimiter (int delim, std::function< void(void *)> slot)
	Добавляет делитель частоты "delim" с необязательным методом "slot".
void	removeDelimiter (int delim)
	Удаляет все делители частоты "delim".
bool	start ()
	Запустить таймер с интервалом interval()
bool	restart ()
	Остановить и запустить таймер с интервалом interval()
void	stop ()
	Остановить таймер (не дожидается остановки)
void	clearDelimiters ()
	Удаляет все делители частоты
void	tickEvent (int delimiter)
	Вызывается каждый тик таймера Подробнее...
Открытые члены унаследованные от PIObject
	PIObject (const PIString &name=PIString())
	Создает PIObject с именем "name".
PIString	name () const
	Возвращает имя объекта
virtual const char *	className () const
	Возвращает имя класса объекта
virtual const char *	parentClassName () const
	Возвращает имя родительского класса
bool	debug () const
	Возвращает включен ли вывод piCoutObj для этого объекта
void	setName (const PIString &name)
	Устанавливает имя объекта
void	setDebug (bool debug)
	Включает или отключает вывод piCoutObj для этого объекта
PIVariant	property (const char *name) const
	Возвращает свойство объекта по имени "name".
void	setProperty (const char *name, const PIVariant &value)
	Устанавливает у объекта свойство по имени "name" в "value". Если такого свойства нет, оно добавляется
bool	isPropertyExists (const char *name) const
	Возвращает присутствует ли свойство по имени "name".
PIStringList	scopeList () const
	Возвращает цепочку наследования объекта (вместе с классом самого объекта)
void	piDisconnect (const PIString &sig, PIObject *dest, void *ev_h)
	Разрывает все соединения от события "sig" к объекту "dest" и обработчику "ev_h".
void	piDisconnect (const PIString &sig, PIObject *dest)
	Разрывает все соединения от события "sig" к объекту "dest".
void	piDisconnect (const PIString &sig)
	Разрывает все соединения от события "sig".
bool	isPIObject () const
	Возвращает действительный ли это PIObject (проверяет подпись)
template<typename T >
bool	isTypeOf () const
	Возвращает действительный ли это наследник PIObject типа "T" (проверяет подпись и имя класса)
template<typename T >
T *	cast () const
	Возвращает преобразование к типу T если это действительный наследник типа "T" (проверяет через isTypeOf()), или "nullptr".
void	callQueuedEvents ()
	Выполнить все отложенные события от CONNECTU_QUEUED соединений
bool	maybeCallQueuedEvents ()
	Если было хотя бы одно CONNECTU_QUEUED соединение с исполнителем this, то выполнить события Подробнее...
void	deleteLater ()
	Пометить объект на удаление Подробнее...
void	deleted (PIObject *o)
	Вызывается перед удалением объекта Подробнее...

Handlers
void	reset ()
	Reset diagnostics counters.
void	received (int size, bool correct)
	Notify diagnostics about "correct" corected received packet.
void	sended (int size)
	Notify diagnostics about sended packet.

Events
void	qualityChanged (PIDiagnostics::Quality new_quality, PIDiagnostics::Quality old_quality)
	Raise on change receive quality from "old_quality" to "new_quality".

Дополнительные унаследованные члены
Открытые статические члены унаследованные от PIObject
static void	piDisconnect (PIObject *src, const PIString &sig, PIObject *dest, void *ev_h)
	Разрывает все соединения от события "sig" объекта "src" к объекту "dest" и обработчику "ev_h".
static void	piDisconnect (PIObject *src, const PIString &sig, PIObject *dest)
	Разрывает все соединения от события "sig" объекта "src" к объекту "dest".
static void	piDisconnect (PIObject *src, const PIString &sig)
	Разрывает все соединения от события "sig" объекта "src".
static PIObject *	findByName (const PIString &name)
	Returns PIObject* with name "name" or 0, if there is no object found.
static bool	isPIObject (const PIObject *o)
	Возвращает действительный ли "o" PIObject (проверяет подпись)
template<typename T >
static bool	isTypeOf (const PIObject *o)
	Возвращает действительный ли "o" наследник PIObject типа "T" (проверяет подпись и имя класса)
virtual void	tick (int delimiter)
	Timer execution function, similar to "slot" or event timeout(). By default does nothing.
Защищенные члены унаследованные от PIObject
PIObject *	emitter () const
	Возвращает PIObject* который вызвал это событие. Значение допустимо только из методов обработчиков событий
virtual void	propertyChanged (const char *name)
	Виртуальная функция, вызывается после изменения любого свойства.
Относящиеся к классу функции унаследованные от PIObject
#define	piCoutObj
	Макрос для условного (piDebug && PIObject::debug()) вывода в PICout(StdOut) для наследников PIObject.
#define	piCerrObj
	Макрос для условного (piDebug && PIObject::debug()) вывода в PICout(StdErr) для наследников PIObject.
#define	PIOBJECT(name)
	Необходимо использовать этот макрос после объявления класса для использования событийной системы и корректного вывода piCoutObj.
#define	EVENT_HANDLER0(ret, name)   ret name()
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name()
#define	EVENT_HANDLER1(ret, name, type0, var0)   ret name(type0 var0)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0)
#define	EVENT_HANDLER2(ret, name, type0, var0, type1, var1)   ret name(type0 var0, type1 var1)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1)
#define	EVENT_HANDLER3(ret, name, type0, var0, type1, var1, type2, var2)   ret name(type0 var0, type1 var1, type2 var2)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1, type2 var2)
#define	EVENT_HANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3)    ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Объявляет обработчик событий с именем "name" и возвращаемым типом "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_HANDLER   EVENT_HANDLER0
	Аналог EVENT_HANDLER0.
#define	EVENT_VHANDLER0(ret, name)   virtual ret name()
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name()
#define	EVENT_VHANDLER1(ret, name, type0, var0)   virtual ret name(type0 var0)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0)
#define	EVENT_VHANDLER2(ret, name, type0, var0, type1, var1)   virtual ret name(type0 var0, type1 var1)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1)
#define	EVENT_VHANDLER3(ret, name, type0, var0, type1, var1, type2, var2)   virtual ret name(type0 var0, type1 var1, type2 var2)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1, type2 var2)
#define	EVENT_VHANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3)    virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Объявляет виртуальный обработчик событий с именем "name" и возвращаемым типом "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_VHANDLER   EVENT_VHANDLER0
	Аналог EVENT_VHANDLER0.
#define	EVENT0(name)   void name();
	Объявляет событие с именем "name", void name();.
#define	EVENT1(name, type0, var0)   void name(type0 var0);
	Объявляет событие с именем "name", void name(type0 var0);.
#define	EVENT2(name, type0, var0, type1, var1)   void name(type0 var0, type1 var1);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1);.
#define	EVENT3(name, type0, var0, type1, var1, type2, var2)   void name(type0 var0, type1 var1, type2 var2);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1, type2 var2);.
#define	EVENT4(name, type0, var0, type1, var1, type2, var2, type3, var3)   void name(type0 var0, type1 var1, type2 var2, type3 var3);
	Объявляет событие с именем "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);.
#define	EVENT   EVENT0
	Аналог EVENT0.
#define	CONNECTU(src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" объекта "dest". Подробнее...
#define	CONNECTU_QUEUED(src, event, dest, handler, performer)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" объекта "dest". Подробнее...
#define	CONNECTL(src, event, functor)
	Соединяет событие "event" объекта "src" к лямбда-функции "functor". Подробнее...
#define	CONNECT0(ret, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...
#define	CONNECT1(ret, type0, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...
#define	CONNECT2(ret, type0, type1, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...
#define	CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...
#define	CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" с проверкой наличия события и обработчика. Подробнее...
#define	CONNECT   CONNECT0
	Аналог CONNECT0. Подробнее...
#define	WEAK_CONNECT0(ret, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...
#define	WEAK_CONNECT1(ret, type0, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...
#define	WEAK_CONNECT2(ret, type0, type1, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...
#define	WEAK_CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...
#define	WEAK_CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Соединяет событие "event" объекта "src" к обработчику или событию "handler" с возвращаемым типом "ret" объекта "dest" без проверки наличия события и обработчика. Подробнее...
#define	WEAK_CONNECT   WEAK_CONNECT0
	Аналог WEAK_CONNECT0. Подробнее...
#define	DISCONNECT0(ret, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"
#define	DISCONNECT1(ret, type0, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"
#define	DISCONNECT2(ret, type0, type1, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"
#define	DISCONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"
#define	DISCONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	piDisconnect событие "event" объекта "src" от обработчика или события "handler" с возвращаемым типом "ret" объекта "dest"
#define	DISCONNECT   DISCONNECT0
	Аналог DISCONNECT0.
#define	HANDLER(handler)
	Возвращает указатель на обработчик события "handler".

Подробное описание

Connection quality diagnostics.

Synopsis

This class provide abstract connection quality diagnostics and counting. You should create instance of PIDiagnostics and on packet receive call function received(), on packet send call function sended(). PIDiagnostics calculates correct, wrong and sended counters, packets per second, bytes per seconds, immediate and integral receive frequencies and receive/send speeds in human readable representation. There statistics are calculates one time per period, by default 1 second. To calculate them you should start PIDiagnostics with function start() or pass true to constructor.

Перечисления

Quality

enum PIDiagnostics::Quality

Connection quality.

Элементы перечислений
Unknown	Unknown, no one packet received yet
Failure	No connection, no one correct packet received for last period
Bad	Bad connection, correct packets received <= 20%
Average	Average connection, correct packets received > 20% and <= 80%
Good	Good connection, correct packets received > 80%