X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;ds=sidebyside;f=server%2Fcontrol.h;h=e6230332cf5215231f77b4ff2d5ff9d8224c36f8;hb=cdbc0c3ae9a368394d5bebf8b6417f1f0fde6a42;hp=cc8f32753c53dcc4a261e053c6231038cfe3acec;hpb=a668061144aa18eb3f127d1b17518fd6ec0cce73;p=matches%2FMCTX3420.git diff --git a/server/control.h b/server/control.h index cc8f327..e623033 100644 --- a/server/control.h +++ b/server/control.h @@ -1,7 +1,35 @@ +/** + * @file control.h + * @brief Header file for control functions + */ #ifndef _CONTROL_H #define _CONTROL_H -typedef enum Actuators {ACT_NONE = -1, ACT_PREG = 0, ACT_SOLENOID1} Actuators; +/** + * 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, + CONTROL_RESUME, + CONTROL_STOP, + CONTROL_EMERGENCY +} ControlModes; + +/** Invalid filename characters **/ +#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 const char * Control_GetModeName(); +//extern bool Control_Lock(); +//extern void Control_Unlock(); +extern const struct timespec* Control_GetStartTime(); #endif