xbmc/utils/Network.h

   1 #ifndef NETWORK_H_
   2 #define NETWORK_H_
   3
   4 /*
   5  *      Copyright (C) 2005-2008 Team XBMC
   6  *      http://www.xbmc.org
   7  *
   8  *  This Program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2, or (at your option)
  11  *  any later version.
  12  *
  13  *  This Program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with XBMC; see the file COPYING.  If not, write to
  20  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *  http://www.gnu.org/copyleft/gpl.html
  22  *
  23  */
  24
  25 #include <vector>
  26 #include "StdString.h"
  27
  28 enum EncMode { ENC_NONE = 0, ENC_WEP = 1, ENC_WPA = 2, ENC_WPA2 = 3 };
  29 enum NetworkAssignment { NETWORK_DASH = 0, NETWORK_DHCP = 1, NETWORK_STATIC = 2, NETWORK_DISABLED = 3 };
  30
  31 class NetworkAccessPoint
  32 {
  33 public:
  34    NetworkAccessPoint(CStdString& essId, int quality, EncMode encryption)
  35    {
  36       m_essId = essId;
  37       m_quality = quality;
  38       m_encryptionMode = encryption;
  39    }
  40
  41    CStdString getEssId() { return m_essId; }
  42    int getQuality() { return m_quality; }
  43    EncMode getEncryptionMode() { return m_encryptionMode; }
  44
  45 private:
  46    CStdString   m_essId;
  47    int          m_quality;
  48    EncMode      m_encryptionMode;
  49 };
  50
  51 class CNetworkInterface
  52 {
  53 public:
  54    virtual ~CNetworkInterface() {};
  55
  56    virtual CStdString& GetName(void) = 0;
  57
  58    virtual bool IsEnabled(void) = 0;
  59    virtual bool IsConnected(void) = 0;
  60    virtual bool IsWireless(void) = 0;
  61
  62    virtual CStdString GetMacAddress(void) = 0;
  63
  64    virtual CStdString GetCurrentIPAddress() = 0;
  65    virtual CStdString GetCurrentNetmask() = 0;
  66    virtual CStdString GetCurrentDefaultGateway(void) = 0;
  67    virtual CStdString GetCurrentWirelessEssId(void) = 0;
  68
  69    // Returns the list of access points in the area
  70    virtual std::vector<NetworkAccessPoint> GetAccessPoints(void) = 0;
  71
  72    virtual void GetSettings(NetworkAssignment& assignment, CStdString& ipAddress, CStdString& networkMask, CStdString& defaultGateway, CStdString& essId, CStdString& key, EncMode& encryptionMode) = 0;
  73    virtual void SetSettings(NetworkAssignment& assignment, CStdString& ipAddress, CStdString& networkMask, CStdString& defaultGateway, CStdString& essId, CStdString& key, EncMode& encryptionMode) = 0;
  74 };
  75
  76
  77
  78 class CNetwork
  79 {
  80 public:
  81   enum EMESSAGE
  82   {
  83     SERVICES_UP,
  84     SERVICES_DOWN
  85   };
  86
  87    CNetwork();
  88    virtual ~CNetwork();
  89
  90    // Return the list of interfaces
  91    virtual std::vector<CNetworkInterface*>& GetInterfaceList(void) = 0;
  92    CNetworkInterface* GetInterfaceByName(CStdString& name);
  93
  94    // Return the first interface which is active
  95    CNetworkInterface* GetFirstConnectedInterface(void);
  96
  97    // Return true if there is a interface for the same network as address
  98    bool HasInterfaceForIP(unsigned long address);
  99
 100    // Return true if there's at least one defined network interface
 101    bool IsAvailable(bool wait = false);
 102
 103    // Return true if there's at least one interface which is connected
 104    bool IsConnected(void);
 105
 106    // Return true if the magic packet was send
 107    bool WakeOnLan(const char *mac);
 108
 109    // Get/set the nameserver(s)
 110    virtual std::vector<CStdString> GetNameServers(void) = 0;
 111    virtual void SetNameServers(std::vector<CStdString> nameServers) = 0;
 112
 113    // callback from application controlled thread to handle any setup
 114    void NetworkMessage(EMESSAGE message, int param);
 115
 116    void StartServices();
 117    void StopServices(bool bWait);
 118
 119    static int ParseHex(char *str, unsigned char *addr);
 120 };
 121 #ifdef HAS_LINUX_NETWORK
 122 #include "linux/NetworkLinux.h"
 123 #else
 124 #include "win32/NetworkWin32.h"
 125 #endif
 126 #endif