simgear/io/HTTPClient.hxx

   1 /**
   2  * \file HTTPClient.hxx - simple HTTP client engine for SimHear
   3  */
   4
   5 // Written by James Turner
   6 //
   7 // Copyright (C) 2013  James Turner  <zakalawe@mac.com>
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Library General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // Library General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23
  24 #ifndef SG_HTTP_CLIENT_HXX
  25 #define SG_HTTP_CLIENT_HXX
  26
  27 #include <memory> // for std::auto_ptr
  28 #include <stdint.h> // for uint_64t
  29
  30 #include <simgear/io/HTTPRequest.hxx>
  31
  32 namespace simgear
  33 {
  34
  35 namespace HTTP
  36 {
  37
  38 // forward decls
  39 class Connection;
  40
  41 class Client
  42 {
  43 public:
  44     Client();
  45     ~Client();
  46
  47     void update(int waitTimeout = 0);
  48
  49     void makeRequest(const Request_ptr& r);
  50
  51     void setUserAgent(const std::string& ua);
  52     void setProxy(const std::string& proxy, int port, const std::string& auth = "");
  53
  54     /**
  55      * Specify the maximum permitted simultaneous connections
  56      * (default value is 1)
  57      */
  58     void setMaxConnections(unsigned int maxCons);
  59
  60     const std::string& userAgent() const;
  61
  62     const std::string& proxyHost() const;
  63
  64     const std::string& proxyAuth() const;
  65
  66     /**
  67      * predicate, check if at least one connection is active, with at
  68      * least one request active or queued.
  69      */
  70     bool hasActiveRequests() const;
  71
  72     /**
  73      * crude tracking of bytes-per-second transferred over the socket.
  74      * suitable for user feedback and rough profiling, nothing more.
  75      */
  76     unsigned int transferRateBytesPerSec() const;
  77
  78     /**
  79      * total bytes downloaded by this HTTP client, for bandwidth usage
  80      * monitoring
  81      */
  82     uint64_t totalBytesDownloaded() const;
  83 private:
  84     void requestFinished(Connection* con);
  85
  86     void receivedBytes(unsigned int count);
  87
  88     friend class Connection;
  89     friend class Request;
  90
  91     class ClientPrivate;
  92     std::auto_ptr<ClientPrivate> d;
  93 };
  94
  95 } // of namespace HTTP
  96
  97 } // of namespace simgear
  98
  99 #endif // of SG_HTTP_CLIENT_HXX