src/lib/encode_server_description.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_ENCODE_SERVER_DESCRIPTION_H
  22 #define DCPOMATIC_ENCODE_SERVER_DESCRIPTION_H
  23
  24 #include "types.h"
  25 #include <boost/date_time/posix_time/posix_time.hpp>
  26
  27 /** @class EncodeServerDescription
  28  *  @brief Class to describe a server to which we can send encoding work.
  29  */
  30 class EncodeServerDescription
  31 {
  32 public:
  33         EncodeServerDescription ()
  34                 : _host_name ("")
  35                 , _threads (1)
  36                 , _link_version (0)
  37                 , _last_seen (boost::posix_time::second_clock::local_time())
  38         {}
  39
  40         /** @param h Server host name or IP address in string form.
  41          *  @param t Number of threads to use on the server.
  42          *  @param l Server link version number of the server.
  43          */
  44         EncodeServerDescription (std::string h, int t, int l)
  45                 : _host_name (h)
  46                 , _threads (t)
  47                 , _link_version (l)
  48                 , _last_seen (boost::posix_time::second_clock::local_time())
  49         {}
  50
  51         /* Default copy constructor is fine */
  52
  53         /** @return server's host name or IP address in string form */
  54         std::string host_name () const {
  55                 return _host_name;
  56         }
  57
  58         /** @return number of threads to use on the server */
  59         int threads () const {
  60                 return _threads;
  61         }
  62
  63         bool current_link_version () const {
  64                 return _link_version == SERVER_LINK_VERSION;
  65         }
  66
  67         void set_host_name (std::string n) {
  68                 _host_name = n;
  69         }
  70
  71         void set_threads (int t) {
  72                 _threads = t;
  73         }
  74
  75         void set_seen () {
  76                 _last_seen = boost::posix_time::second_clock::local_time();
  77         }
  78
  79         int last_seen_seconds () const {
  80                 return boost::posix_time::time_duration(boost::posix_time::second_clock::local_time() - _last_seen).total_seconds();
  81         }
  82
  83 private:
  84         /** server's host name */
  85         std::string _host_name;
  86         /** number of threads to use on the server */
  87         int _threads;
  88         /** server link (i.e. protocol) version number */
  89         int _link_version;
  90         boost::posix_time::ptime _last_seen;
  91 };
  92
  93 #endif