include/proto-def.h

   1 /*
   2    proto-def.h -- provide a REST/HTTP interface
   3
   4    Copyright (C) 2015, Fulup Ar Foll
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19
  20 */
  21
  22 // helper-api
  23 PUBLIC json_object* getPingTest(AFB_request *request);
  24 PUBLIC const char* getQueryValue (const AFB_request * request, const char *name);
  25 PUBLIC int getQueryAll(AFB_request * request, char *query, size_t len);
  26 PUBLIC AFB_PostHandle* getPostHandle (AFB_request *request);
  27 PUBLIC json_object* getPostFile (AFB_request *request, AFB_PostItem *item, char* destination) ;
  28 PUBLIC AFB_PostCtx* getPostContext (AFB_request *request);
  29 PUBLIC char* getPostPath (AFB_request *request);
  30
  31 // rest-api
  32 PUBLIC void endPostRequest(AFB_PostHandle *posthandle);
  33 PUBLIC int doRestApi(struct MHD_Connection *connection, AFB_session *session, const char* url, const char *method
  34     , const char *upload_data, size_t *upload_data_size, void **con_cls);
  35
  36 void initPlugins (AFB_session *session);
  37
  38 typedef AFB_plugin* (*AFB_pluginCB)();
  39 PUBLIC  AFB_plugin* pluginRegister ();
  40
  41 // Session handling
  42 PUBLIC AFB_error sessionCheckdir     (AFB_session *session);
  43 PUBLIC json_object *sessionList      (AFB_session *session, AFB_request *request);
  44 PUBLIC json_object *sessionToDisk    (AFB_session *session, AFB_request *request, char *name,json_object *jsonSession);
  45 PUBLIC json_object *sessionFromDisk  (AFB_session *session, AFB_request *request, char *name);
  46
  47 PUBLIC AFB_error ctxTokenRefresh (AFB_clientCtx *clientCtx, AFB_request *request);
  48 PUBLIC AFB_error ctxTokenCreate (AFB_clientCtx *clientCtx, AFB_request *request);
  49 PUBLIC AFB_error ctxTokenCheck (AFB_clientCtx *clientCtx, AFB_request *request);
  50 PUBLIC AFB_error ctxTokenReset (AFB_clientCtx *clientCtx, AFB_request *request);
  51 PUBLIC AFB_clientCtx *ctxClientGet (AFB_request *request, int idx);
  52 PUBLIC void      ctxStoreInit (int);
  53
  54
  55
  56 // Httpd server
  57 PUBLIC AFB_error httpdStart          (AFB_session *session);
  58 PUBLIC AFB_error httpdLoop           (AFB_session *session);
  59 PUBLIC void  httpdStop               (AFB_session *session);
  60
  61
  62 // config management
  63 PUBLIC char *configTime        (void);
  64 PUBLIC AFB_session *configInit (void);
  65 PUBLIC json_object *jsonNewMessage (AFB_error level, char* format, ...);
  66 PUBLIC json_object *jsonNewStatus (AFB_error level);
  67 PUBLIC json_object *jsonNewjtype (void);
  68 PUBLIC json_object *jsonNewMessage (AFB_error level, char* format, ...);
  69 PUBLIC void jsonDumpObject (json_object * jObject);
  70 PUBLIC AFB_error configLoadFile (AFB_session * session, AFB_config *cliconfig);
  71 PUBLIC void configStoreFile (AFB_session * session);
  72
  73