EchoLinkDirectory.h

Go to the documentation of this file.

#ifndef ECHOLINK_DIRECTORY_INCLUDED
#define ECHOLINK_DIRECTORY_INCLUDED


/****************************************************************************
 *
 * System Includes
 *
 ****************************************************************************/

#include <sigc++/sigc++.h>

#include <string>
#include <list>
#include <vector>
#include <iostream>


/****************************************************************************
 *
 * Project Includes
 *
 ****************************************************************************/

#include <AsyncTcpClient.h>
#include <AsyncTimer.h>
#include <EchoLinkStationData.h>


/****************************************************************************
 *
 * Local Includes
 *
 ****************************************************************************/



/****************************************************************************
 *
 * Forward declarations
 *
 ****************************************************************************/

class Cmd;


/****************************************************************************
 *
 * Namespace
 *
 ****************************************************************************/

namespace EchoLink
{

/****************************************************************************
 *
 * Defines & typedefs
 *
 ****************************************************************************/



/****************************************************************************
 *
 * Exported Global Variables
 *
 ****************************************************************************/



/****************************************************************************
 *
 * Class definitions
 *
 ****************************************************************************/

class Directory : public SigC::Object
{
  public:
    static const unsigned MAX_DESCRIPTION_SIZE = 27;
    
    Directory(const std::string& server, const std::string& callsign,
          const std::string& password, const std::string& description="");
  
    ~Directory(void);
    
    void makeOnline(void);
    
    void makeBusy(void);
    
    void makeOffline(void);
    
    void refreshRegistration(void) { onRefreshRegistration(0); }
    
    StationData::Status status(void) const { return current_status; }
    
    std::string statusStr(void) const
    { 
      return StationData::statusStr(current_status);
    }
    
    void getCalls(void);
    
    void setServer(const std::string& server);
    
    const std::string& server(void) const { return the_server; }
    
    void setCallsign(const std::string& callsign);
    
    const std::string& callsign(void) const { return the_callsign; }
    
    void setPassword(const std::string& password);

    const std::string& password(void) const { return the_password; }
    
    void setDescription(const std::string& description);

    const std::string& description(void) const { return the_description; }
    
    const std::list<StationData>& links(void) const { return the_links; }
    
    const std::list<StationData>& repeaters(void) const
    {
      return the_repeaters;
    }
    
    const std::list<StationData>& conferences(void) const
    {
      return the_conferences;
    }
    
    const std::list<StationData>& stations(void) const { return the_stations; }
    
    const std::string& message(void) const { return the_message; }
    
    const StationData *findCall(const std::string& call);
    
    const StationData *findStation(int id);

    void findStationsByCode(std::vector<StationData> &stns,
                    const std::string& code, bool exact=true);
    
    SigC::Signal1<void, StationData::Status> statusChanged;
    
    SigC::Signal0<void> stationListUpdated;
    
    SigC::Signal1<void, const std::string&> error;
    
  protected:
    
  private:
    typedef enum
    {
      CS_WAITING_FOR_START, CS_WAITING_FOR_COUNT, CS_WAITING_FOR_CALL,
      CS_WAITING_FOR_DATA,  CS_WAITING_FOR_ID,    CS_WAITING_FOR_IP,
      CS_WAITING_FOR_END,   CS_IDLE,              CS_WAITING_FOR_OK
    } ComState;
    
    static const int DIRECTORY_SERVER_PORT      = 5200;
    static const int REGISTRATION_REFRESH_TIME  = 5 * 60 * 1000; // 5 minutes
    static const int CMD_TIMEOUT                = 120 * 1000; // 2 minutes
    
    ComState                com_state;
    std::string             the_server;
    std::string             the_callsign;
    std::string             the_password;
    std::string             the_description;
    std::list<StationData>  the_links;
    std::list<StationData>  the_repeaters;
    std::list<StationData>  the_stations;
    std::list<StationData>  the_conferences;
    std::string             the_message;
    std::string             error_str;
    
    int                     get_call_cnt;
    StationData             get_call_entry;
    std::list<StationData>  get_call_list;
    
    Async::TcpClient *      ctrl_con;
    std::list<Cmd>          cmd_queue;
    StationData::Status     the_status;
    Async::Timer *          reg_refresh_timer;
    StationData::Status     current_status;
    bool                    server_changed;
    Async::Timer *          cmd_timer;
    
    Directory(const Directory&);
    Directory& operator =(const Directory&);
    
    void printBuf(const unsigned char *buf, int len);
    int handleCallList(char *buf, int len);
    
    void ctrlSockConnected(void);
    void ctrlSockDisconnected(Async::TcpConnection *con,
            Async::TcpClient::DisconnectReason reason);
    int ctrlSockDataReceived(Async::TcpConnection *con, void *ptr, int len);
    void sendNextCmd(void);
    void addCmdToQueue(Cmd cmd);
    void setStatus(StationData::Status new_status);
    void createClientObject(void);
    void onRefreshRegistration(Async::Timer *timer);
    void onCmdTimeout(Async::Timer *timer);
    bool stationCodeEq(const StationData& stn, std::string code, bool exact);

};  /* class Directory */


std::ostream& operator<<(std::ostream& os, const StationData& station);


} /* namespace */


#endif /* ECHOLINK_DIRECTORY_INCLUDED */



/*
 * This file has not been truncated
 */