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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* 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_AddressList.h
* @brief A list of CPIAddress instances.
*
* An AddressList is a list of addresses.
* It wraps a PARCLinkedList for type saftey with CPIAddress.
*
*/
#ifndef libccnx_cpi_AddressList_h
#define libccnx_cpi_AddressList_h
#include <ccnx/api/control/cpi_Address.h>
struct cpi_addresslist;
/**
* @typedef CPIAddressList
* @abstract A list of CPIAddress instance pointers.
*/
typedef struct cpi_addresslist CPIAddressList;
/**
* Create an instance of {@link CPIAddressList}
*
* @return NULL An error occurred
* @return non-NULL A pointer to a valid CPIAddressList instance.
*
* Example:
* @code
* {
* CPIAddressList *list = cpiAddressList_Create();
*
* }
* @endcode
*
* @see cpiAddressList_Destroy
*/
CPIAddressList *cpiAddressList_Create(void);
/**
* Dellocate and destroy a CPIAddressList instance.
*
* @param [in] addressListPtr A pointer to a pointer to a valid {@link CPIAddressList}.
*
*
* Example:
* @code
* {
* CPIAddressList *list = cpiAddressList_Create(void);
* cpiAddressList_Destroy(&list);
* }
* @endcode
*
* @see cpiAddressList_Create
*/
void cpiAddressList_Destroy(CPIAddressList **addressListPtr);
/**
* Appends the address, taking ownership of the memory
*
* @param list A pointer to a CPIAddressList.
* @param address must be non-null
* @return The input list
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIAddressList *cpiAddressList_Append(CPIAddressList *list, CPIAddress *address);
/**
* Creates a reference counted copy
*
* @param list A pointer to a valid {@link CPIAddressList}.
*
* @return An allocated list, you must destroy it.
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIAddressList *cpiAddressList_Copy(const CPIAddressList *list);
/**
* Determine if two CPIAddressList instances are equal.
*
* Two CPIAddressList instances are equal if, and only if, they have the same length,
* with the same elements in the same order.
*
*
* The following equivalence relations on non-null `CPIAddressList` instances are maintained:
*
* * It is reflexive: for any non-null reference value x, `CPIAddressList_Equals(x, x)`
* must return true.
*
* * It is symmetric: for any non-null reference values x and y,
* `CPIAddressList_Equals(x, y)` must return true if and only if
* `cpiAddressList_Equals(y, x)` returns true.
*
* * It is transitive: for any non-null reference values x, y, and z, if
* `cpiAddressList_Equals(x, y)` returns true and
* `cpiAddressList_Equals(y, z)` returns true,
* then `cpiAddressList_Equals(x, z)` must return true.
*
* * It is consistent: for any non-null reference values x and y, multiple
* invocations of `cpiAddressList_Equals(x, y)` consistently return true or
* consistently return false.
*
* * For any non-null reference value x, `cpiAddressList_Equals(x, NULL)` must
* return false.
*
* @param a A pointer to a `CPIAddressList` instance.
* @param b A pointer to a `CPIAddressList` instance.
* @return true if the two `CPIAddressList` instances are equal.
*
* Example:
* @code
* {
* CPIAddressList *a = cpiAddressList_Create();
* CPIAddressList *b = cpiAddressList_Create();
*
* if (cpiAddressList_Equals(a, b)) {
* // true
* } else {
* // false
* }
* }
* @endcode
*/
bool cpiAddressList_Equals(const CPIAddressList *a, const CPIAddressList *b);
/**
* Get the number of items in the list
*
* @param list A pointer to a {@link CPIAddressList}.
* @return The number of items in the list.
*
* Example:
* @code
* <#example#>
* @endcode
*/
size_t cpiAddressList_Length(const CPIAddressList *list);
/**
* Returns a const reference to an item.
* Use CPIAddress_Copy if needed.
*
* Do not free or modify the returned value.
* Use CPIAddress_Copy if you need a mutable instance.
*
* @param list A pointer to a CPIAddressList.
* @param item A value less than the number of items in the given {@link CPIAddressList}.
* @return Asserts if item off end of list.
*
* Example:
* @code
* <#example#>
* @endcode
*/
const CPIAddress *cpiAddressList_GetItem(const CPIAddressList *list, size_t item);
/**
* Returns a JSON array of the addresses
*
* { "ADDRS" : [ {addr0}, {addr1}, ..., {addrN} ] }
*
* @param list A pointer to a CPIAddressList.
* @return A JSON object, even if array empty
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCJSONArray *cpiAddressList_ToJson(const CPIAddressList *list);
/**
* Creates an address list based on a JSON array
*
* { "ADDRS" : [ {addr0}, {addr1}, ..., {addrN} ] }
*
* @param json A pointer to a valid PARCJSON instance.
* @return An allocated address list.
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIAddressList *cpiAddressList_CreateFromJson(PARCJSONArray *json);
/**
* Get a nul-terminated, C-string representation of the given {@link CPIAddressList}.
*
* @param list A pointer to a valid {@link CPIAddressList} instance.
*
* @return An allocate string representation of the {@link CPIAddressList} that must be freed via `parcMemory_Deallocate()`.
*
* Example:
* @code
* <#example#>
* @endcode
*/
char *cpiAddressList_ToString(const CPIAddressList *list);
#endif // libccnx_cpi_AddressList_h
|
