From 46d9538587a3521caa1e3b20bf337a53ed400777 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Tue, 19 Apr 2016 13:23:08 +0200 Subject: refactoring context handling MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I0e5a900efbd94b66f309ff4d0d49a6406585203f Signed-off-by: José Bollo --- plugins/samples/ClientCtx.c | 42 ++++++------------------------------------ plugins/session/token-api.c | 19 +++++++++---------- 2 files changed, 15 insertions(+), 46 deletions(-) (limited to 'plugins') diff --git a/plugins/samples/ClientCtx.c b/plugins/samples/ClientCtx.c index 24cb4f30..11d10240 100644 --- a/plugins/samples/ClientCtx.c +++ b/plugins/samples/ClientCtx.c @@ -21,19 +21,6 @@ #include "afb-plugin.h" -typedef struct { - /* - * In case your plugin is implemented on multiple files or used share routines - * with other plugins, it might not be possible to use global static variable. - * In this case you can attach a static handle to your plugin. This handle - * is passed within each API call under request->handle - * - */ - void *anythingYouWant; - - -} MyPluginHandleT; - typedef struct { /* * client context is attached a session but private to a each plugin. @@ -57,24 +44,19 @@ typedef struct { } MyClientContextT; - -// Plugin handle should not be in stack (malloc or static) -static MyPluginHandleT global_handle; - // This function is call at session open time. Any client trying to // call it with an already open session will be denied. // Ex: http://localhost:1234/api/context/create?token=123456789 static void myCreate (struct afb_req request) { MyClientContextT *ctx = malloc (sizeof (MyClientContextT)); - MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle; // store something in our plugin private client context ctx->count = 0; ctx->abcd = "SomeThingUseful"; - *request.context = ctx; - afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", handle->anythingYouWant); + afb_req_context_set(request, ctx, free); + afb_req_success_f(request, NULL, "SUCCESS: create client context for plugin [%s]", ctx->abcd); } // This function can only be called with a valid token. Token should be renew before @@ -83,12 +65,11 @@ static void myCreate (struct afb_req request) // ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx static void myAction (struct afb_req request) { - MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle; - MyClientContextT *ctx = (MyClientContextT*) *request.context; + MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); // store something in our plugin private client context ctx->count++; - afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", handle->anythingYouWant, ctx->count); + afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Check=[%d]\n", ctx->abcd, ctx->count); } // After execution of this function, client session will be close and if they @@ -97,20 +78,11 @@ static void myAction (struct afb_req request) // ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx static void myClose (struct afb_req request) { - MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle; - MyClientContextT *ctx = (MyClientContextT*) *request.context; + MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request); // store something in our plugin private client context ctx->count++; - afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", handle->anythingYouWant, ctx->count); -} - -static void freeCtxCB (MyClientContextT *ctx) { - MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle; - fprintf (stderr, "FreeCtxCB Plugin=[%s] count=[%d]", (char*)handle->anythingYouWant, ctx->count); - free (ctx); - - // Note: handle should be free it is a static resource attached to plugin and not to session + afb_req_success_f(request, NULL, "SUCCESS: plugin [%s] Close=[%d]\n", ctx->abcd, ctx->count); } // NOTE: this sample does not use session to keep test a basic as possible @@ -127,12 +99,10 @@ static const struct AFB_plugin plugin_desc = { .info = "Sample of Client Context Usage", .prefix = "context", .apis = pluginApis, - .freeCtxCB = (void*)freeCtxCB }; const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf) { - global_handle.anythingYouWant = "anythingYouWant"; return &plugin_desc; } diff --git a/plugins/session/token-api.c b/plugins/session/token-api.c index 91f9cd8f..bd76ceef 100644 --- a/plugins/session/token-api.c +++ b/plugins/session/token-api.c @@ -28,13 +28,20 @@ typedef struct { } MyClientApplicationHandle; +// This function is call when Client Session Context is removed +// Note: when freeCtxCB==NULL standard free/malloc is called +static void clientContextFree(void *context) { + fprintf (stderr,"Plugin[token] Closing Session\n"); + free (context); +} + // Request Creation of new context if it does not exist static void clientContextCreate (struct afb_req request) { json_object *jresp; // add an application specific client context to session - request.context = malloc (sizeof (MyClientApplicationHandle)); + afb_req_context_set(request, malloc (sizeof (MyClientApplicationHandle)), clientContextFree); // Send response to UI jresp = json_object_new_object(); @@ -92,13 +99,6 @@ static void clientGetPing (struct afb_req request) { } -// This function is call when Client Session Context is removed -// Note: when freeCtxCB==NULL standard free/malloc is called -static void clientContextFree(void *context) { - fprintf (stderr,"Plugin[token] Closing Session\n"); - free (context); -} - static const struct AFB_restapi pluginApis[]= { {"ping" , AFB_SESSION_NONE , clientGetPing ,"Ping Rest Test Service"}, {"create" , AFB_SESSION_CREATE, clientContextCreate ,"Request Client Context Creation"}, @@ -112,8 +112,7 @@ static const struct AFB_plugin plugin_desc = { .type = AFB_PLUGIN_JSON, .info = "Application Framework Binder Service", .prefix = "token", - .apis = pluginApis, - .freeCtxCB = clientContextFree + .apis = pluginApis }; const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf) -- cgit 1.2.3-korg