net_manager.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL 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 2, or (at your option)
 * any later version.

 * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */




/**************************************************************************
********************* THIS CLASS IS DEPRECATED ****************************
**************************************************************************/

#ifdef NL_OS_WINDOWS
#   pragma message(NL_LOC_WRN "You are using a deprecated feature of NeL, consider rewriting your code with replacement feature")
#else // NL_OS_UNIX
#   warning "You are using a deprecated feature of NeL, consider rewriting your code with replacement feature"
#endif

#ifndef NL_NET_MANAGER_H
#define NL_NET_MANAGER_H

#include "nel/misc/types_nl.h"

#include <string>
#include <map>
#include <vector>

#include "nel/misc/time_nl.h"
#include "nel/misc/string_id_array.h"

#include "callback_net_base.h"
#include "naming_client.h"

namespace NLNET {

typedef void (*TNetManagerCallback) (const std::string &serviceName, TSockId from, void *arg);

struct CBaseStruct
{
    CBaseStruct (const std::string &sn) :
        Name(sn), ConnectionCallback(NULL), ConnectionCbArg(NULL),
        DisconnectionCallback(NULL), DisconnectionCbArg(NULL), Type(Unknown)
    { }

    std::string Name;

    enum TBaseStructType { Unknown, Client, ClientWithAddr, Group, Server };

    std::vector<std::string>        ServiceNames;

    std::vector<CCallbackNetBase*>   NetBase;

    TNetManagerCallback              ConnectionCallback;
    void                            *ConnectionCbArg;

    TNetManagerCallback              DisconnectionCallback;
    void                            *DisconnectionCbArg;

    // autoretry is used only when Type is ClientWithAddr. If true, the CNetManager will retry to reconnect if it lost the connection
    bool                             AutoRetry;

    TBaseStructType                  Type;
};

class CNetManager
{
public:

    static void init (const CInetAddress *addr, CCallbackNetBase::TRecordingState rec );

    static void release ();

    static void addServer (const std::string &serviceName, uint16 servicePort = 0, bool external = false);

    static void addServer (const std::string &serviceName, uint16 servicePort, NLNET::TServiceId &sid, bool external = false);

    static void addClient (const std::string &serviceName, const std::string &addr, bool autoRetry = true);

    static void addClient (const std::string &serviceName);

    static void addGroup (const std::string &groupName, const std::string &serviceName);

    static void addCallbackArray (const std::string &serviceName, const TCallbackItem *callbackarray, NLMISC::CStringIdArray::TStringId arraysize);

    static void update (NLMISC::TTime timeout = 0);

    static void send (const std::string &serviceName, const CMessage &buffer, TSockId hostid = InvalidSockId);

    static void setConnectionCallback (const std::string &serviceName, TNetManagerCallback cb, void *arg);

    static void setDisconnectionCallback (const std::string &serviceName, TNetManagerCallback cb, void *arg);

    static CCallbackNetBase *getNetBase (const std::string &serviceName);

    static void setUpdateTimeout (uint32 timeout);

    static void createConnection(CBaseStruct &Base, const CInetAddress &Addr, const std::string& name);

    static uint64 getBytesSent ();
    static uint64 getBytesReceived ();

    static uint64 getReceiveQueueSize ();
    static uint64 getSendQueueSize ();

private:

    typedef std::map<std::string, CBaseStruct>  TBaseMap;
    typedef TBaseMap::iterator                  ItBaseMap;

    // Contains all the connections (client and server)
    static  TBaseMap    _BaseMap;

    static  CCallbackNetBase::TRecordingState _RecordingState;

    // used to synchonize the timeout in the update function
    static  NLMISC::TTime _NextUpdateTime;

    // Finds the service or add it if not found
    static  ItBaseMap find (const std::string &serviceName);

    friend  void RegistrationBroadcast (const std::string &name, TServiceId sid, const std::vector<CInetAddress> &addr);


    // It's a static class, you can't instanciate it
    CNetManager() { }
};


} // NLNET


#endif // NL_NET_MANAGER_H

/* End of net_manager.h */