blob: 36ad04411abb2d04169153c4337ad19b0e85521b (
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* 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_Acks.h
*
*
* Example:
* @code
* <#example#>
* @endcode
*/
#ifndef libccnx_cpi_Acks_h
#define libccnx_cpi_Acks_h
#include <stdbool.h>
#include <stdint.h>
#include <parc/algol/parc_JSON.h>
struct control_plane_ack;
typedef struct control_plane_ack CPIAck;
#define cpiAck "CPI_ACK"
#define cpiSeqnum "SEQUENCE"
/**
* Create a CPIAck instance from a PARCJSON instance.
*
* @param [in] json A pointer to a valid PARCJSON instance.
*
* @return NULL An error occurred.
* @return non-NULL A pointer to a valid CPIAck instance.
*
* Example:
* @code
* <#example#>
* @endcode
*
*/
CPIAck *cpiAcks_ParseJSON(const PARCJSON *json);
/**
* Create a CPIAck instance.
*
* @param [in] sequenceNumber The sequence number for the ACK.
*
* @return NULL An error occurred.
* @return non-NULL A pointer to a valid CPIAck instance.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
*/
CPIAck *cpiAcks_Create(uint64_t sequenceNumber);
/**
* Create a CPIAck instance, from a template of the original request.
*
* @param [in] originalRequest A pointer to a valid PARCJSON instance containint he original request.
*
* @return NULL An error occurred.
* @return non-NULL A pointer to a valid PARCJSON instance.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
*/
PARCJSON *cpiAcks_CreateAck(const PARCJSON *originalRequest);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
* @return <#value#> <#explanation#>
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
*/
PARCJSON *cpiAcks_CreateNack(const PARCJSON *request);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
* @return <#value#> <#explanation#>
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
bool cpiAcks_IsAck(const PARCJSON *json);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
* @return <#value#> <#explanation#>
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
*/
uint64_t cpiAcks_GetAckOriginalSequenceNumber(const PARCJSON *json);
#endif // libccnx_cpi_Acks_h
|
