src/lib/encode_server_finder.h

   1 /*
   2     Copyright (C) 2013-2018 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 /** @file  src/lib/encode_server_finder.h
  22  *  @brief EncodeServerFinder class.
  23  */
  24
  25 #include "signaller.h"
  26 #include "encode_server_description.h"
  27 #include "config.h"
  28 #include "exception_store.h"
  29 #include <boost/signals2.hpp>
  30 #include <boost/thread/condition.hpp>
  31
  32 class Socket;
  33
  34 /** @class EncodeServerFinder
  35  *  @brief Locater of encoding servers.
  36  *
  37  *  This class finds active (i.e. responding) encode servers.  Depending on
  38  *  configuration it finds servers by:
  39  *
  40  *  1. broadcasting a request to the local subnet and
  41  *  2. checking to see if any of the configured server hosts are up.
  42  */
  43 class EncodeServerFinder : public Signaller, public ExceptionStore
  44 {
  45 public:
  46         static EncodeServerFinder* instance ();
  47         static void drop ();
  48
  49         void stop ();
  50
  51         std::list<EncodeServerDescription> servers () const;
  52
  53         /** Emitted whenever the list of servers changes */
  54         boost::signals2::signal<void ()> ServersListChanged;
  55
  56 private:
  57         EncodeServerFinder ();
  58         ~EncodeServerFinder ();
  59
  60         void start ();
  61
  62         void search_thread ();
  63         void listen_thread ();
  64
  65         bool server_found (std::string) const;
  66         void start_accept ();
  67         void handle_accept (boost::system::error_code ec, boost::shared_ptr<Socket> socket);
  68
  69         void config_changed (Config::Property what);
  70
  71         /** Thread to periodically issue broadcasts and requests to find encoding servers */
  72         boost::thread* _search_thread;
  73         /** Thread to listen to the responses from servers */
  74         boost::thread* _listen_thread;
  75
  76         std::list<EncodeServerDescription> _servers;
  77         mutable boost::mutex _servers_mutex;
  78
  79         boost::asio::io_service _listen_io_service;
  80         boost::shared_ptr<boost::asio::ip::tcp::acceptor> _listen_acceptor;
  81         bool _stop;
  82
  83         boost::condition _search_condition;
  84         boost::mutex _search_condition_mutex;
  85
  86         static EncodeServerFinder* _instance;
  87 };