api-v3: First draft
[src/app-framework-binder.git] / include / afb / afb-req-v1.h
1 /*
2  * Copyright (C) 2016, 2017, 2018 "IoT.bzh"
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #pragma once
19
20 #include <stdlib.h>
21 #include "afb-req-x1.h"
22
23 /**
24  * @deprecated use bindings version 3
25  *
26  * Stores 'req' on heap for asynchrnous use.
27  * Returns a pointer to the stored 'req' or NULL on memory depletion.
28  * The count of reference to 'req' is incremented on success
29  * (see afb_req_addref).
30  */
31 static inline struct afb_req_x1 *afb_req_x1_store_v1(struct afb_req_x1 req)
32 {
33         struct afb_req_x1 *result = (struct afb_req_x1*)malloc(sizeof *result);
34         if (result) {
35                 *result = req;
36                 afb_req_x1_addref(req);
37         }
38         return result;
39 }
40
41 /**
42  * @deprecated use bindings version 3
43  *
44  * Retrieves the afb_req stored at 'req' and frees the memory.
45  * Returns the stored request.
46  * The count of reference is UNCHANGED, thus, normally, the
47  * function 'afb_req_unref' should be called on the result
48  * after that the asynchronous reply if sent.
49  */
50 static inline struct afb_req_x1 afb_req_unstore_x1_v1(struct afb_req_x1 *req)
51 {
52         struct afb_req_x1 result = *req;
53         free(req);
54         return result;
55 }
56