/*
- * Copyright (C) 2015 "IoT.bzh"
+ * Copyright (C) 2015, 2016 "IoT.bzh"
* Author "Fulup Ar Foll"
*
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
*/
+#define _GNU_SOURCE
+#include <stdio.h>
+#include <json-c/json.h>
-#include "local-def.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;
+#include <afb/afb-plugin.h>
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 json_object* myCreate (AFB_request *request) {
- json_object *jresp;
-
- MyClientContextT *ctx= malloc (sizeof (MyClientContextT));
- MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle;
+static void myCreate (struct afb_req request)
+{
+ MyClientContextT *ctx = malloc (sizeof (MyClientContextT));
// store something in our plugin private client context
ctx->count = 0;
ctx->abcd = "SomeThingUseful";
- request->context = ctx;
- jresp = jsonNewMessage(AFB_SUCCESS, "SUCCESS: create client context for plugin [%s]", handle->anythingYouWant);
-
- return jresp;
+ 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
// session timeout a standard renew api is avaliable at /api/token/renew this API
// can be called automatically with <token-renew> HTML5 widget.
// ex: http://localhost:1234/api/context/action?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
-STATIC json_object* myAction (AFB_request *request) {
- json_object* jresp;
- MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle;
- MyClientContextT *ctx= (MyClientContextT*) request->context;
+static void myAction (struct afb_req request)
+{
+ MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
// store something in our plugin private client context
ctx->count++;
- jresp = jsonNewMessage(AFB_SUCCESS, "SUCCESS: plugin [%s] Check=[%d]\n", handle->anythingYouWant, ctx->count);
-
- return jresp;
+ 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
// created a context [request->context != NULL] every plugins will be notified
// that they should free context resources.
// ex: http://localhost:1234/api/context/close?token=xxxxxx-xxxxxx-xxxxx-xxxxx-xxxxxx
-STATIC json_object* myClose (AFB_request *request) {
- json_object* jresp;
- MyPluginHandleT *handle = (MyPluginHandleT*) &global_handle;
- MyClientContextT *ctx= (MyClientContextT*) request->context;
+static void myClose (struct afb_req request)
+{
+ MyClientContextT *ctx = (MyClientContextT*) afb_req_context_get(request);
// store something in our plugin private client context
ctx->count++;
- jresp = jsonNewMessage(AFB_SUCCESS, "SUCCESS: plugin [%s] Close=[%d]\n", handle->anythingYouWant, ctx->count);
-
- // Note Context resource should be free in FreeCtxCB and not here in case session timeout.
- return jresp;
-}
-
-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
// in real application most APIs should be protected with AFB_SESSION_CHECK
-STATIC AFB_restapi pluginApis[]= {
- {"create", AFB_SESSION_CREATE, (AFB_apiCB)myCreate , "Create a new session"},
- {"action", AFB_SESSION_CHECK , (AFB_apiCB)myAction , "Use Session Context"},
- {"close" , AFB_SESSION_CLOSE , (AFB_apiCB)myClose , "Free Context"},
+static const struct AFB_restapi pluginApis[]= {
+ {"create", AFB_SESSION_CREATE, myCreate , "Create a new session"},
+ {"action", AFB_SESSION_CHECK , myAction , "Use Session Context"},
+ {"close" , AFB_SESSION_CLOSE , myClose , "Free Context"},
{NULL}
};
-PUBLIC AFB_plugin *pluginRegister () {
-
- AFB_plugin *plugin = malloc (sizeof (AFB_plugin));
- plugin->type = AFB_PLUGIN_JSON;
- plugin->info = "Sample of Client Context Usage";
- plugin->prefix = "context";
- plugin->apis = pluginApis;
- plugin->freeCtxCB= (AFB_freeCtxCB) freeCtxCB;
-
- // feed plugin handle before returning from registration
- global_handle.anythingYouWant = "My Plugin Handle";
-
- return (plugin);
+static const struct AFB_plugin plugin_desc = {
+ .type = AFB_PLUGIN_JSON,
+ .info = "Sample of Client Context Usage",
+ .prefix = "context",
+ .apis = pluginApis,
};
+
+const struct AFB_plugin *pluginRegister (const struct AFB_interface *itf)
+{
+ return &plugin_desc;
+}
+
Code Review / src / app-framework-binder.git / blobdiff