aboutsummaryrefslogtreecommitdiff
path: root/statsd/stats.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'statsd/stats.hpp')
-rw-r--r--statsd/stats.hpp20
1 files changed, 20 insertions, 0 deletions
diff --git a/statsd/stats.hpp b/statsd/stats.hpp
index bcf85c5..4e1c18f 100644
--- a/statsd/stats.hpp
+++ b/statsd/stats.hpp
@@ -9,6 +9,13 @@
#include <list>
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The Stats class A daemon that receives statistics on a socket and writes it to CSV.
+ */
class Stats {
boost::asio::io_service& io_service;
Server server;
@@ -27,8 +34,21 @@ class Stats {
void handle_message(std::list<Receiver>::iterator it, cmix_proto::CMixMessage message);
public:
+ /*!
+ * \brief Stats The statsd server to be created.
+ * \param io_service The io_service it will run under.
+ * \param lsettings The listen_settings that it will use.
+ */
Stats(boost::asio::io_service& io_service, ListenSettings lsettings);
+ /*!
+ * \brief run Stars the stats daemon, Does not return unless the io_service ends.
+ */
void run();
+
+ /*!
+ * \brief output Writes the data to file.
+ * \param file The filename to write it to.
+ */
void output(std::string file);
};