X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=server%2Ffastcgi.h;h=f52a20aafbfebc55a2711dd907268975380dccef;hb=8f94dbb551783aad414b57ba6da4596f19dc80a6;hp=c4d2ef55bfd64235251be392aec8411407863eaf;hpb=744b902d7f7b532ddb19d95828d8787653e1b84c;p=matches%2FMCTX3420.git

diff --git a/server/fastcgi.h b/server/fastcgi.h
index c4d2ef5..f52a20a 100644
--- a/server/fastcgi.h
+++ b/server/fastcgi.h
@@ -1,16 +1,22 @@
 /**
  * @file fastcgi.h
- * @purpose Headers for the fastcgi web interface
+ * @brief Headers for the fastcgi web interface
  */
  
 #ifndef _FASTCGI_H
 #define _FASTCGI_H
  
-/**(HTTP) Status codes that fcgi module handlers can return**/
+/**
+ * Status codes that fcgi module handlers can return
+ * Success status codes have values > 0
+ * Failure status codes have values <(=) 0 
+ * Note: 0 is counted as an error code to minimise confusion
+ * with in-browser JSON parsing error codes
+ */
 typedef enum StatusCodes {
-	STATUS_OK = 200,
-	STATUS_ERROR = 400,
-	STATUS_UNAUTHORIZED = 401
+	STATUS_OK = 1,
+	STATUS_ERROR = -1,
+	STATUS_UNAUTHORIZED = -2
 } StatusCodes;
 
 typedef struct FCGIContext FCGIContext;
@@ -26,12 +32,27 @@ extern void FCGI_JSONLong(const char *key, long value);
 extern void FCGI_JSONDouble(const char *key, double value);
 extern void FCGI_JSONBool(const char *key, bool value);
 extern void FCGI_JSONKey(const char *key);
-extern void FCGI_JSONValue(const char *format, ...);
+extern void FCGI_PrintRaw(const char *format, ...);
 extern void FCGI_EndJSON();
-extern void FCGI_RejectJSON(FCGIContext *context);
 extern void FCGI_RejectJSONEx(FCGIContext *context, StatusCodes status, const char *description);
-extern void * FCGI_RequestLoop (void *data);
-#define FCGI_PrintRaw FCGI_JSONValue // Functionality is identical
+extern void *FCGI_RequestLoop (void *data);
+
+/**
+ * Shortcut to calling FCGI_RejectJSONEx. Sets the error code
+ * to STATUS_ERROR.
+ * @param context The context to work in
+ * @param description A short description of why the request was rejected.
+ * @see FCGI_RejectJSONEx
+ */
+#define FCGI_RejectJSON(context, description) FCGI_RejectJSONEx(context, STATUS_ERROR, description)
+
+/**
+ * Custom formatting function for the JSON value. To be used in 
+ * conjunction with FCGI_JSONKey. Care should be taken to ensure
+ * that valid JSON is produced.
+ * @see FCGI_PrintRaw for calling syntax
+ */
+#define FCGI_JSONValue FCGI_PrintRaw
 
 #endif