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
223
224
225
226
227
228
229
230
231
232
|
/*
* 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_InterfaceSet.h
* @brief <#Brief Description#>
*
* <#Detailed Description#>
*
*/
#ifndef libccnx_cpi_InterfaceSet_h
#define libccnx_cpi_InterfaceSet_h
#include <ccnx/api/control/cpi_Interface.h>
struct cpi_interface_set;
/**
*
* @see cpiInterfaceSet_Create
*/
typedef struct cpi_interface_set CPIInterfaceSet;
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
CPIInterfaceSet *cpiInterfaceSet_Create(void);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
void cpiInterfaceSet_Destroy(CPIInterfaceSet **setPtr);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
CPIInterfaceSet *cpiInterfaceSet_FromJson(PARCJSON *json);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
PARCJSON *cpiInterfaceSet_ToJson(CPIInterfaceSet *iface);
/**
* Adds interface to set, does not allow duplicates
*
* Takes ownership of the iface memory if added
*
* Duplicates are two entries with the same interface index
*
* @param <#param1#>
* @return true if added, false if not (likely a duplicate)
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool cpiInterfaceSet_Add(CPIInterfaceSet *set, CPIInterface *iface);
/**
* The number of interfaces in the set
*
* <#Discussion#>
*
* @param <#param1#>
* @return <#return#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
size_t cpiInterfaceSet_Length(const CPIInterfaceSet *set);
/**
* Uses the ordinal index of the interface in the Set
*
* Ranges from 0 .. <code>cpiInterfaceSet_Length()-1</code>.
*
* @param <#param1#>
* @return NULL if not found
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIInterface *cpiInterfaceSet_GetByOrdinalIndex(CPIInterfaceSet *set, size_t ordinalIndex);
/**
* Retreives by the CPI assigned interface index
*
* <#Discussion#>
*
* @param <#param1#>
* @return NULL if not found
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIInterface *cpiInterfaceSet_GetByInterfaceIndex(const CPIInterfaceSet *set, unsigned interfaceIndex);
/**
* Uses the system name (e.g. "en0")
*
* <#Discussion#>
*
* @param <#param1#>
* @return NULL if not found
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIInterface *cpiInterfaceSet_GetByName(CPIInterfaceSet *set, const char *name);
/**
* Determine if two CPIInterfaceSet instances are equal.
*
* Two CPIInterfaceSet instances are equal if, and only if, the sets contain the same elements
* - order independent.
* Each element is compared via <code>cpiInterface_Equals()</code>
*
* The following equivalence relations on non-null `CPIInterfaceSet` instances are maintained:
*
* * It is reflexive: for any non-null reference value x, `CPIInterfaceSet_Equals(x, x)`
* must return true.
*
* * It is symmetric: for any non-null reference values x and y,
* `CPIInterfaceSet_Equals(x, y)` must return true if and only if
* `cpiInterfaceSet_Equals(y, x)` returns true.
*
* * It is transitive: for any non-null reference values x, y, and z, if
* `cpiInterfaceSet_Equals(x, y)` returns true and
* `cpiInterfaceSet_Equals(y, z)` returns true,
* then `cpiInterfaceSet_Equals(x, z)` must return true.
*
* * It is consistent: for any non-null reference values x and y, multiple
* invocations of `cpiInterfaceSet_Equals(x, y)` consistently return true or
* consistently return false.
*
* * For any non-null reference value x, `cpiInterfaceSet_Equals(x, NULL)` must
* return false.
*
* @param a A pointer to a `CPIInterfaceSet` instance.
* @param b A pointer to a `CPIInterfaceSet` instance.
* @return true if the two `CPIInterfaceSet` instances are equal.
*
* Example:
* @code
* {
* CPIInterfaceSet *a = cpiInterfaceSet_Create();
* CPIInterfaceSet *b = cpiInterfaceSet_Create();
*
* if (cpiInterfaceSet_Equals(a, b)) {
* // true
* } else {
* // false
* }
* }
* @endcode
*/
bool cpiInterfaceSet_Equals(const CPIInterfaceSet *a, const CPIInterfaceSet *b);
#endif // libccnx_cpi_InterfaceSet_h
|
