2005-12-03 Richard D. Worth <richard@theworths.org>

[ttt] / src / ttt-server.h

diff --git a/src/ttt-server.h b/src/ttt-server.h
index fef70308dbb59b91df593de7b7fc39c2ba1d85e3..8f2d34b7c1bd5b2b6c08cef9aa0f8d3867b9b2ec 100644 (file)
--- a/src/ttt-server.h
+++ b/src/ttt-server.h
@@ -73,6 +73,22 @@ ttt_server_broadcast (ttt_server_t *server, const char *message);
 const char*
 ttt_server_who (ttt_server_t *server);
 
+/* Generates the statistics for the user. If the function does not
+ * return an error, the response will be allocated in this function
+ * and will need to be free'd by the caller.
+ *
+ * Locking: The server mutex will be acquired and held throughout the
+ * execution of this function. Each client mutex may also be acquired
+ * and held by functions called during the execution of this function.
+ *
+ * Errors: If an error such as an IO error occurs, this function will
+ * not return.
+ */
+ttt_error_t
+ttt_server_statistics (ttt_server_t *server,
+                      const char *username,
+                      char **response);
+
 /* Gets the server hostname.
  *
  */