client.h

/***************************************************************************
 * The contents of this file are subject to the Mozilla Public             *
 * License Version 1.1 (the "License"); you may not use this file          *
 * except in compliance with the License. You may obtain a copy of         *
 * the License at http://www.mozilla.org/MPL/                              *
 *                                                                         *
 * Software distributed under the License is distributed on an "AS         *
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or              *
 * implied. See the License for the specific language governing            *
 * rights and limitations under the License.                               *
 *                                                                         *
 * The Original Code is Game Network Framework (GaNeF).                    *
 *                                                                         *
 * The Initial Developers of the Original Code are                         *
 * Lars Langer and Emanuel Greisen                                         *
 * Copyright (C) 2005. Lars Langer & Emanuel Greisen                       *
 * All Rights Reserved.                                                    *
 *                                                                         *
 * Contributor(s):                                                         *
 *   none yet....                                                          *
 *                                                                         *
 ***************************************************************************/
#ifndef CLIENT_H
#define CLIENT_H

#include <pinet.h>
USING_PTYPES

#include "../common/averagetimecalculator.h"
#include "../common/frameworkseqnolist.h"

class ServerPacket;
class ServerFramework;
/**
 * @ingroup Server
 * @brief An object of this class represents a client currently connected to the server.
 * You should create your own class inheriting from this one so you can associate any data you wish with a client/player in the game.
 *
 * @author Lars Langer and Emanuel Greisen
 */
class Client
{
friend bool operator== (const Client &c1, const Client &c2);

private:
   static unsigned int next_uid;

private:
   ServerFramework * server_framework;
   unsigned int uid;
   ipaddress addr;
   int port;
   AverageTimeCalculator<8,50,1,1000> rtt_time;
   /// These are held for each priority, and one for pre-send-chains(plugins).
   FrameworkSeqNoList<ServerPacket,ipmsgserver> sequencenumbers;
   bool has_called_on_connect;
   bool has_called_on_disconnect;
   unsigned int last_packet_received;

public:
   enum ClientState
   {
      NEWCLIENT            = 0,
      CONNECTED            = 1,
      CONNECTION_ABORTED   = 2,
      DICONNECTED          = 3,
   };
   inline const ClientState getState() const { return state; };
   inline void setState(const ClientState & _s ) { state = _s; };

private:
   ClientState state;

public:
   Client(ServerFramework * fw, const ipaddress &addr, int port);
   ~Client();

public:
   const ipaddress &getAddress(){ return addr; };
   const int         getPort()   { return port; };
   const unsigned int getId() const { return uid; };

public:
   inline void registerRTT( unsigned int ms ){ rtt_time.registerValue(ms); };
   inline void registerLastPacketReceivedTime( unsigned int time ){ last_packet_received = time; };
   inline unsigned int getLastPacketReceivedTime() const { return last_packet_received; };
   inline unsigned int getRTT() const { return rtt_time.getAvg(); };
   inline unsigned int getNextOutgoingSeqNo( ServerPacket * packet ) { return sequencenumbers.getNextOutgoingSeqNo(packet); };
   inline bool hasCalledOnConnect() const { return has_called_on_connect; };
   inline void setCalledOnConnect(bool b){ has_called_on_connect = b; };
   inline bool hasCalledOnDisconnect() const { return has_called_on_disconnect; };
   inline void setCalledOnDisconnect(bool b){ has_called_on_disconnect = b; };
   bool isPacketReadyForDelivery(ServerPacket * packet);
   ServerPacket * incrementNextIngoingSeqNo( ServerPacket * packet );
   inline unsigned int bufferedPackets( ) const { return sequencenumbers.bufferePacketsTotal(); };
   unsigned int getNextOutgoingPacketSeqNumber(ServerPacket * packet);
};

/// Used when clients connect to see if its a reconnect.
bool operator== (const Client &c1, const Client &c2);

std::ostream & operator<<(std::ostream & o, Client & client);


#endif

---