server/control.h

   1 /**
   2  * @file control.h
   3  * @brief Header file for control functions
   4  */
   5 #ifndef _CONTROL_H
   6 #define _CONTROL_H
   7
   8 /**
   9  * The possible experiment control modes that the server can be in.
  10  * At present, CONTROL_EMERGENCY largely does nothing. TODO: Fix this
  11  */
  12 typedef enum ControlModes {
  13         CONTROL_START,
  14         CONTROL_PAUSE,
  15         CONTROL_RESUME,
  16         CONTROL_STOP,
  17         CONTROL_EMERGENCY
  18 } ControlModes;
  19
  20 /** Invalid filename characters **/
  21 #define INVALID_CHARACTERS "\"*/:<>?\\|. "
  22 /** The same as INVALID_CHARACTERS, except escaped for use in JSON strings **/
  23 #define INVALID_CHARACTERS_JSON "\\\"*/:<>?\\\\|. "
  24 /** The username of a user with no authentication (DEBUG ONLY) **/
  25 #define NOAUTH_USERNAME "_anonymous_noauth"
  26
  27 extern void Control_Handler(FCGIContext *context, char *params);
  28 extern const char* Control_SetMode(ControlModes desired_mode, void * arg);
  29 //extern ControlModes Control_GetMode();
  30 extern const char * Control_GetModeName();
  31 //extern bool Control_Lock();
  32 //extern void Control_Unlock();
  33 extern const struct timespec* Control_GetStartTime();
  34
  35 #endif