X-Git-Url: https://git.ucc.asn.au/?p=matches%2FMCTX3420.git;a=blobdiff_plain;f=server%2Fcontrol.h;fp=server%2Fcontrol.h;h=e6230332cf5215231f77b4ff2d5ff9d8224c36f8;hp=0dfdc47c4a8a191884606f7320cc439222e04321;hb=b7a1e44bd6c984d061b0b88a8b00cf24b854a1df;hpb=7deca6b4e089e76e279ae84c0aa25728d91e8fd9

diff --git a/server/control.h b/server/control.h
index 0dfdc47..e623033 100644
--- a/server/control.h
+++ b/server/control.h
@@ -5,6 +5,10 @@
 #ifndef _CONTROL_H
 #define _CONTROL_H
 
+/** 
+ * The possible experiment control modes that the server can be in.
+ * At present, CONTROL_EMERGENCY largely does nothing. TODO: Fix this
+ */
 typedef enum ControlModes {
 	CONTROL_START,
 	CONTROL_PAUSE,
@@ -17,12 +21,12 @@ typedef enum ControlModes {
 #define INVALID_CHARACTERS "\"*/:<>?\\|. "
 /** The same as INVALID_CHARACTERS, except escaped for use in JSON strings **/
 #define INVALID_CHARACTERS_JSON "\\\"*/:<>?\\\\|. "
-
+/** The username of a user with no authentication (DEBUG ONLY) **/
 #define NOAUTH_USERNAME "_anonymous_noauth"
 
 extern void Control_Handler(FCGIContext *context, char *params);
 extern const char* Control_SetMode(ControlModes desired_mode, void * arg);
-extern ControlModes Control_GetMode();
+//extern ControlModes Control_GetMode();
 extern const char * Control_GetModeName();
 //extern bool Control_Lock();
 //extern void Control_Unlock();