/* bzflag
 * Copyright (c) 1993-2017 Tim Riker
 *
 * This package is free software;  you can redistribute it and/or
 * modify it under the terms of the license found in the file
 * named COPYING that should have accompanied this file.
 *
 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef __LAGINFO_H__
#define __LAGINFO_H__

#include "PlayerInfo.h"

/** This class monitors the lag time for each client
*/
class LagInfo {
public:
  /** A default constructor.
      It needs a pointer to the Player basic Info,
   */
  LagInfo(PlayerInfo *_info);

  /** Resetting lag value
  */
  void	reset();
  /** Getting lag value (in milliseconds)
  */
  int	getLag() const;
  /** Getting jitter value (in milliseconds)
  */
  int	getJitter() const;
  /** Getting packetloss value (in percent)
  */
  int	getLoss() const;
  /** Get the floating point value of the lag (in seconds)
  */
  float	getLagAvg() const;
  /** Get a printable version of lag statistics
  */
  void	getLagStats(char* msg, bool isAdmin) const;
  /** functions to be called whenever a playerUpdate or ping message arrives
   */
  void	updatePingLag(const void *buf, bool &warn, bool &kick,
		      bool &jittwarn, bool &jittkick,
		      bool &plosswarn, bool &plosskick,
		      bool &alagannouncewarn, bool &lagannouncewarn);
  void	updateLag(float timestamp, bool ooo);
  /** get the ping seqno, if need to send one now!
   */
  int	getNextPingSeqno(bool &warn, bool &kick);
  /** update the latency
   */
  void	updateLatency(float &waitTime);
  /** set the threshold for warning/kicking
   */
  static void setAdminLagAnnounceThreshold(float _adminlagannouncetresh);
  static void setLagAnnounceThreshold(float _lagannouncetresh);
  static void setThreshold(float _threshold, float _max);
  static void setJitterThreshold(float _jitterthreshold, float _jittermax);
  static void setPacketLossThreshold(float _packetlossthreshold, float _max);
private:
  PlayerInfo *info;
  // lag measurement
  float       lagavg;
  float       jitteravg;
  float       lostavg;
  float       lagalpha;
  float       jitteralpha;
  float       lostalpha;
  int	 lagcount;
  int	 laglastwarn;
  int	 lagwarncount;
  int	 jittercount;
  int	 jitterlastwarn;
  int	 jitterwarncount;
  int    losscount;
  int    losslastwarn;
  int    losswarncount;
  bool	pingpending;
  TimeKeeper  nextping;
  TimeKeeper  lastping;
  TimeKeeper  lastupdate;
  int	 pingseqno;
  int	 pingssent;
  // jitter measurement
  float       lasttimestamp;

  // announcements
  static float adminlagannouncetresh;
  int	 alagcount;
  int	 alaglastannounce;
  int	 alagannouncecount;
  static float lagannouncetresh;
  int	 lagannouncecount;
  TimeKeeper laglastannounce;


  // kicks
  static float threshold;
  static float jitterthreshold;
  static float lossthreshold;
  static float max;
  static float jittermax;
  static float lossmax;
};

#endif

// Local Variables: ***
// mode: C++ ***
// tab-width: 8 ***
// c-basic-offset: 2 ***
// indent-tabs-mode: t ***
// End: ***
// ex: shiftwidth=2 tabstop=8
