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
233
234
235
236
|
/*
* 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_Interface.h
* @brief <#Brief Description#>
*
* <#Detailed Description#>
*
*/
#ifndef libccnx_cpi_Interface_h
#define libccnx_cpi_Interface_h
#include <ccnx/api/control/cpi_Address.h>
#include <ccnx/api/control/cpi_AddressList.h>
struct cpi_interface;
typedef struct cpi_interface CPIInterface;
/**
* Creates a representation of an interface
*
* The name is copied. Creates a representation of a system interface.
*
* @param <#param1#>
* @return An allocated object, you must call <code>cpiInterface_Destroy()</code>
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIInterface *cpiInterface_Create(const char *name, unsigned interfaceIndex, bool loopback, bool supportMulticast, unsigned mtu);
void cpiInterface_Destroy(CPIInterface **interfacePtr);
/**
* Creates an Interface object based on a JSON description.
*
* <#Discussion#>
*
* @param <#param1#>
* @return An allocated object, you must call <code>cpiInterface_Destroy()</code>
*
* Example:
* @code
* <#example#>
* @endcode
*/
CPIInterface *cpiInterface_FromJson(PARCJSON *json);
/**
* Creates a JSON description of the object
*
* <#Discussion#>
*
* @param <#param1#>
* @return An allocated object, you must destroy it.
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCJSON *cpiInterface_ToJson(CPIInterface *iface);
/**
* Adds an address to an interface
*
* Does not allow duplicates, if already exists is not added again
*
* @param <#param1#>
* @return <#return#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void cpiInterface_AddAddress(CPIInterface *iface, CPIAddress *address);
/**
* Retrieves a list of interface addresses
*
* <#Discussion#>
*
* @param <#param1#>
* @return Will not be NULL, but may be empty
*
* Example:
* @code
* <#example#>
* @endcode
*/
const CPIAddressList *cpiInterface_GetAddresses(const CPIInterface *iface);
/**
* The interface index
*
* <#Discussion#>
*
* @param <#param1#>
* @return <#return#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
unsigned cpiInterface_GetInterfaceIndex(const CPIInterface *iface);
/**
* Returns the interface name, e.g. "eth0"
*
* <#Paragraphs Of Explanation#>
*
* @param [in] iface An allocated CPIInterface
*
* @return non-null The interface Name as a C-string
* @return null An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
const char *cpiInterface_GetName(const CPIInterface *iface);
/**
* Returns the Maximum Transmission Unit (MTU) of the interface
*
* <#Paragraphs Of Explanation#>
*
* @param [in] iface An allocated CPIInterface
*
* @return number The MTU as reported by the kernel
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
unsigned cpiInterface_GetMTU(const CPIInterface *iface);
/**
* Determine if two CPIInterfaceName instances are equal.
*
*
* The following equivalence relations on non-null `CPIInterfaceName` instances are maintained:
*
* * It is reflexive: for any non-null reference value x, `CPIInterfaceName_Equals(x, x)`
* must return true.
*
* * It is symmetric: for any non-null reference values x and y,
* `cpiInterfaceName_Equals(x, y)` must return true if and only if
* `cpiInterfaceName_Equals(y, x)` returns true.
*
* * It is transitive: for any non-null reference values x, y, and z, if
* `cpiInterfaceName_Equals(x, y)` returns true and
* `cpiInterfaceName_Equals(y, z)` returns true,
* then `cpiInterfaceName_Equals(x, z)` must return true.
*
* * It is consistent: for any non-null reference values x and y, multiple
* invocations of `cpiInterfaceName_Equals(x, y)` consistently return true or
* consistently return false.
*
* * For any non-null reference value x, `cpiInterfaceName_Equals(x, NULL)` must
* return false.
*
* @param a A pointer to a `CPIInterfaceName` instance.
* @param b A pointer to a `CPIInterfaceName` instance.
* @return true if the two `CPIInterfaceName` instances are equal.
*
* Example:
* @code
* {
* CPIInterfaceName *a = cpiInterfaceName_Create();
* CPIInterfaceName *b = cpiInterfaceName_Create();
*
* if (cpiInterfaceName_Equals(a, b)) {
* // true
* } else {
* // false
* }
* }
* @endcode
*/
bool cpiInterface_NameEquals(const CPIInterface *iface, const char *name);
/**
* Two CPIInterfaces are idential
*
* All properties must be the same. The order of addresses matters, and
* they must have been added to the address list in the same order.
*
* The interface name match is case in-sensitive.
*
* @param <#param1#>
* @return <#return#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool cpiInterface_Equals(const CPIInterface *a, const CPIInterface *b);
/**
* <#OneLineDescription#>
*
* <#Discussion#>
*
* @param interface A CPIInterface structure pointer.
* @return An allocate string representation of the CPIInterface that must be freed via parcMemory_Deallocate().
*
* Example:
* @code
* <#example#>
* @endcode
*/
char *cpiInterface_ToString(const CPIInterface *interface);
#endif // libccnx_cpi_Interface_h
|
