summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2017-07-27 11:06:25 +0100
committerCarl Hetherington <cth@carlh.net>2017-07-27 11:06:25 +0100
commitd79b3415d397dd81d21263c2cc35b77dca1e7997 (patch)
treeb7efcd4bdbd83e145d9d97563ef7950a713f475f /src/lib
parent47af90d2db2a7fcc0aaf4d4e598b9b5de0124ad4 (diff)
Add comment.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/encode_server_finder.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib/encode_server_finder.h b/src/lib/encode_server_finder.h
index c639dfe3b..da610bd54 100644
--- a/src/lib/encode_server_finder.h
+++ b/src/lib/encode_server_finder.h
@@ -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: