aboutsummaryrefslogtreecommitdiffstats
path: root/libccnx-transport-rta/ccnx/api/control/cpi_private.h
diff options
context:
space:
mode:
Diffstat (limited to 'libccnx-transport-rta/ccnx/api/control/cpi_private.h')
-rw-r--r--libccnx-transport-rta/ccnx/api/control/cpi_private.h60
1 files changed, 60 insertions, 0 deletions
diff --git a/libccnx-transport-rta/ccnx/api/control/cpi_private.h b/libccnx-transport-rta/ccnx/api/control/cpi_private.h
new file mode 100644
index 00000000..e13d347d
--- /dev/null
+++ b/libccnx-transport-rta/ccnx/api/control/cpi_private.h
@@ -0,0 +1,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