/*
 * clients.h - Author: Keith Fulton
 *
 * Copyright (C) 2001 Atomic Blue (info@planeshift.it, http://www.atomicblue.org) 
 *
 *
 * 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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
#ifndef __CLIENTS_H__
#define __CLIENTS_H__

#include <csutil/hash.h>
#include <csutil/thread.h>

#include "client.h"

class ClientIterator;
class iResultRow;

/**
 * This class is a list of several CLient objects, it's designed for finding
 * clients very fast based on their clientnum or their IP address.
 * This class is also threadsafe now
 */
class ClientConnectionSet
{
protected:
    friend class ClientIterator;
    
    BinaryRBTree<Client> tree;
    csHash<Client*> hash;
    csRef<csMutex> mutex;

public:
    ClientConnectionSet();
    ~ClientConnectionSet();

    bool Initialize();

    Client *Add(LPSOCKADDR_IN addr);
    void Delete(Client* client);
    size_t Count(void) const;

    ///  Find by 32bit id value, used in UDP messages, returns ready or not.
    Client *FindAny(uint32_t id);
    ///  Find by 32bit id value, used in UDP messages.  Returns NULL if found but not ready.
    Client *Find(uint32_t id);
    /// Find by player name, used for Chat and other purposes. Returns NULL if found but not ready.
    Client *Find(const char* name);
    /// Find by player id
    Client *FindPlayer(int playerID);
    /// Find by account id
    Client *FindAccount(int accountID);
    /// Find by IP addr and Port
    Client *Find(LPSOCKADDR_IN addr);

    /// Remove specified entity from any client who has this entity targeted
    void ClearAllTargets(gemObject *obj);
};

class ClientIterator : public BinaryRBIterator<Client>
{
public:
    ClientIterator (ClientConnectionSet& clients);
    ~ClientIterator ();
    
private:
    csRef<csMutex> mutex;
};


#endif