Provide efficient store/unstore for afb_req

[src/app-framework-binder.git] / include / afb / afb-req-v1.h

diff --git a/include/afb/afb-req-v1.h b/include/afb/afb-req-v1.h
new file mode 100644 (file)
index 0000000..03b4ee6
--- /dev/null
+++ b/include/afb/afb-req-v1.h
@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Author: José Bollo <jose.bollo@iot.bzh>
+ *
+ * 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include <stdlib.h>
+#include "afb-req-common.h"
+
+/*
+ * Stores 'req' on heap for asynchrnous use.
+ * Returns a pointer to the stored 'req' or NULL on memory depletion.
+ * The count of reference to 'req' is incremented on success
+ * (see afb_req_addref).
+ */
+static inline struct afb_req *afb_req_store_v1(struct afb_req req)
+{
+       struct afb_req *result = (struct afb_req*)malloc(sizeof *result);
+       if (result != NULL) {
+               *result = req;
+               afb_req_addref(req);
+       }
+       return result;
+}
+
+/*
+ * Retrieves the afb_req stored at 'req' and frees the memory.
+ * Returns the stored request.
+ * The count of reference is UNCHANGED, thus, normally, the
+ * function 'afb_req_unref' should be called on the result
+ * after that the asynchronous reply if sent.
+ */
+static inline struct afb_req afb_req_unstore_v1(struct afb_req *req)
+{
+       struct afb_req result = *req;
+       free(req);
+       return result;
+}
+