pip/pidiagnostics.h

/*! \file pidiagnostics.h
 * \brief Connection quality diagnostics
*/
/*
    PIP - Platform Independent Primitives
    Speed and quality in/out diagnostics
    Copyright (C) 2013  Ivan Pelipenko peri4ko@gmail.com, Bychkov Andrey wapmobil@gmail.com

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef PIDIAGNOSTICS_H
#define PIDIAGNOSTICS_H

#include "pitimer.h"


class PIP_EXPORT PIDiagnostics: private PITimer
{
	PIOBJECT(PIDiagnostics)
public:
	
	//! Constructs an empty diagnostics and if "strat_" start it
	PIDiagnostics(bool start_ = true);
	
	virtual ~PIDiagnostics() {;}
	
	//! Connection quality
	enum Quality {
		Unknown /** Unknown, no one packet received yet */ = 1,
		Failure /** No connection, no one correct packet received for last period */ = 2,
		Bad /** Bad connection, correct packets received <= 20% */ = 3,
		Average /** Average connection, correct packets received > 20% and <= 80% */ = 4,
		Good /** Good connection, correct packets received > 80% */ = 5
	};
	
	
	//! Returns immediate receive frequency, packets/s
	float immediateFrequency() const {return immediate_freq;}
	
	//! Returns integral receive frequency for period, packets/s
	float integralFrequency() const {return integral_freq;}
	
	//! Returns correct received packets per second
	ullong receiveCountPerSec() const {return packets_in_sec;}
	
	//! Returns sended packets per second
	ullong sendCountPerSec() const {return packets_out_sec;}
	
	//! Returns correct received bytes per second
	ullong receiveBytesPerSec() const {return bytes_in_sec;}
	
	//! Returns sended bytes per second
	ullong sendBytesPerSec() const {return bytes_out_sec;}
	
	//! Returns overall correct received packets count
	ullong receiveCount() const {return receive_count;}
	
	//! Returns overall wrong received packets count
	ullong wrongCount() const {return wrong_count;}
	
	//! Returns overall sended packets count
	ullong sendCount() const {return send_count;}
	
	//! Returns connection quality
	PIDiagnostics::Quality quality() const {return qual;}
	
	//! Returns receive speed in format "n {B|kB|MB|GB|TB}/s"
	PIString receiveSpeed() const {return speedIn;}
	
	//! Returns send speed in format "n {B|kB|MB|GB|TB}/s"
	PIString sendSpeed() const {return speedOut;}
	
	
	//! Returns immediate receive frequency pointer, packets/s. Useful for output to PIConsole
	const float * immediateFrequency_ptr() const {return &immediate_freq;}
	
	//! Returns integral receive frequency pointer for period, packets/s. Useful for output to PIConsole
	const float * integralFrequency_ptr() const {return &integral_freq;}
	
	//! Returns correct received packets per second pointer. Useful for output to PIConsole
	const ullong * receiveCountPerSec_ptr() const {return &packets_in_sec;}
	
	//! Returns sended packets per second pointer. Useful for output to PIConsole
	const ullong * sendCountPerSec_ptr() const {return &packets_out_sec;}
	
	//! Returns correct received bytes per second pointer. Useful for output to PIConsole
	const ullong * receiveBytesPerSec_ptr() const {return &bytes_in_sec;}
	
	//! Returns sended bytes per second pointer. Useful for output to PIConsole
	const ullong * sendBytesPerSec_ptr() const {return &bytes_out_sec;}
	
	//! Returns overall correct received packets count pointer. Useful for output to PIConsole
	const ullong * receiveCount_ptr() const {return &receive_count;}
	
	//! Returns overall wrong received packets count pointer. Useful for output to PIConsole
	const ullong * wrongCount_ptr() const {return &wrong_count;}
	
	//! Returns overall sended packets count pointer. Useful for output to PIConsole
	const ullong * sendCount_ptr() const {return &send_count;}
	
	//! Returns connection quality pointer. Useful for output to PIConsole
	const int * quality_ptr() const {return (int * )&qual;}
	
	//! Returns receive speed pointer in format "n {B|kB|MB|GB|TB}/s". Useful for output to PIConsole
	const PIString * receiveSpeed_ptr() const {return &speedIn;}
	
	//! Returns send speed pointer in format "n {B|kB|MB|GB|TB}/s". Useful for output to PIConsole
	const PIString * sendSpeed_ptr() const {return &speedOut;}
	
	EVENT_HANDLER0(void, start) {start(1000.);}
	EVENT_HANDLER1(void, start, double, msecs) {if (msecs > 0.) PITimer::start(msecs);}
	EVENT_HANDLER0(void, reset);
	
	EVENT_HANDLER1(void, received, int, size) {received(size, true);}
	EVENT_HANDLER2(void, received, int, size, bool, correct);
	EVENT_HANDLER1(void, sended, int, size);
	
	EVENT2(qualityChanged, PIDiagnostics::Quality, new_quality, PIDiagnostics::Quality, old_quality)
	
//! \handlers
//! \{
	
	//! \fn void start(double msecs = 1000.)
	//! \brief Start diagnostics evaluations with period "msecs" milliseconds
	
	//! \fn void reset()
	//! \brief Reset diagnostics counters
	
	//! \fn void received(int size, bool correct = true)
	//! \brief Notify diagnostics about "correct" corected received packet
	
	//! \fn void sended(int size)
	//! \brief Notify diagnostics about sended packet
	
//! \}
//! \events
//! \{

	//! \fn void qualityChanged(PIDiagnostics::Quality new_quality, PIDiagnostics::Quality old_quality)
	//! \brief Raise on change receive quality from "old_quality" to "new_quality"

//! \}
	
private:
	void tick(void * data, int delimiter);
	void changeDisconnectTimeout();

	PIDiagnostics::Quality qual;
	PIString speedIn, speedOut;
	float ifreq, immediate_freq, integral_freq;
	int packets[2];
	char cur_pckt, rec_once;
	ullong wrong_count, receive_count, send_count;
	ullong packets_in_sec, packets_out_sec, bytes_in_sec, bytes_out_sec;
	
};

#endif // PIDIAGNOSTICS_H