Merge branch 'master' of ssh://git.carlh.net/home/carl/git/dcpomatic

[dcpomatic.git] / src / lib / encode_server_finder.h

diff --git a/src/lib/encode_server_finder.h b/src/lib/encode_server_finder.h
index c639dfe3bf3aabdd641ee4295348699ca7cd2b0d..46d66b191e24d04cb103ffa5aeac9f3a669ae5aa 100644 (file)
--- a/src/lib/encode_server_finder.h
+++ b/src/lib/encode_server_finder.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -31,6 +31,15 @@
 
 class Socket;
 
+/** @class EncodeServerFinder
+ *  @brief Locater of encoding servers.
+ *
+ *  This class finds active (i.e. responding) encode servers.  Depending on
+ *  configuration it finds servers by:
+ *
+ *  1. broadcasting a request to the local subnet and
+ *  2. checking to see if any of the configured server hosts are up.
+ */
 class EncodeServerFinder : public Signaller, public ExceptionStore
 {
 public: