aboutsummaryrefslogtreecommitdiffstats
path: root/libccnx-transport-rta/ccnx/api/control/cpi_private.h
blob: e13d347d4f589a5e3bacc5d4f61d2c43961f5131 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * 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.
 */

/**
 * @file cpi_private.h
 * @brief <#Brief Description#>
 *
 * <#Detailed Description#>
 *
 */

#ifndef libccnx_cpi_private_h
#define libccnx_cpi_private_h

uint64_t cpi_GetNextSequenceNumber(void);

/**
 * Wrap the operation in a CPI_REQUEST and add sequence number
 *
 *   <#Discussion#>
 *
 * @param <#param1#>
 * @return JSON "{ CPI_REQUEST: { SEQUENCE:number key: { operation } }}"
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCJSON *cpi_CreateRequest(const char *key, PARCJSON *operation);

/**
 * <#OneLineDescription#>
 *
 *   INPUT: "{ CPI_REQUEST: { SEQUENCE:number key: { operation } }}"
 *   OUTPUT: "{ key : { operation } }"
 *
 *   Example: "{ REGISTER : { <code>cpiRoute_ToJson()</code> } }"
 * @param <#param1#>
 * @return <#return#>
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCJSONPair *cpi_ParseRequest(PARCJSON *request);
#endif // libccnx_cpi_private_h