summaryrefslogtreecommitdiffstats
path: root/libccnx-common/ccnx/common/ccnx_Link.h
blob: cd2b62ff1ad29c97f582192508ca0bd3c4bc4eea (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
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*
 * 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 ccnx_Link.h
 * @ingroup ContentObject
 * @brief A generic CCNx link that contains a hash, name, KeyID.
 *
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
#ifndef libccnx_ccnx_Link_h
#define libccnx_ccnx_Link_h

#include <ccnx/common/ccnx_Name.h>

#include <parc/security/parc_Signature.h>
#include <parc/algol/parc_Memory.h>
#include <parc/algol/parc_Buffer.h>

struct ccnx_link;

/**
 * @typedef CCNxLink
 * @brief A generic CCNx link that contains a hash, name, KeyID.
 * @see {@link ccnxLink_Create}
 */
typedef struct ccnx_link CCNxLink;

/**
 * Create a new `CCNxLink` instance.
 *
 * @param [in] name The {@link CCNxName} for the new `CCNxLink`.
 * @param [in] keyId A {@link PARCBuffer} containing the KeyID for the new `CCNxLink`.
 * @param [in] contentObjectHash A `PARCBuffer` containing the Content Object Hash for the new `CCNxLink`.
 * @return A pointer to a new `CCNxLink` instance, or NULL if an error or out of memory.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
CCNxLink *ccnxLink_Create(const CCNxName *name, PARCBuffer *keyId, PARCBuffer *contentObjectHash);

/**
 * Create a new `CCNxLink` instance as a copy of the original.
 *
 * @param [in] original The {@link CCNxLink} to copy.
 * @return A pointer to a new `CCNxLink` instance, or NULL if an error or out of memory.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
CCNxLink *ccnxLink_Copy(const CCNxLink *original);

/**
 * Fetch the name associated with this `CCNxLink`.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance
 * @return The {@link CCNxName} associated with the @p link.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
const CCNxName *ccnxLink_GetName(const CCNxLink *link);

/**
 * Fetch the KeyID associated with this `CCNxLink`.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance
 * @return a {@link PARCBuffer} containing the KeyID associated with the @p link.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCBuffer *ccnxLink_GetKeyID(const CCNxLink *link);

/**
 * Fetch the ContentObjectHash associated with this `CCNxLink`.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance
 * @return a {@link PARCBuffer} containing the Content Object Hash associated with the @p link.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCBuffer *ccnxLink_GetContentObjectHash(const CCNxLink *link);

/**
 * Determine if two `CCNxLink` instances are equal.
 *
 * The following equivalence relations on non-null `CCNxLink` instances are maintained:
 *
 *   * It is reflexive: for any non-null reference value x, `ccnxLink_Equals(x, x)` must return true.
 *
 *   * It is symmetric: for any non-null reference values x and y, `ccnxLink_Equals(x, y)` must return true if and only if
 *        `ccnxLink_Equals(y x)` returns true.
 *
 *   * It is transitive: for any non-null reference values x, y, and z, if
 *        `ccnxLink_Equals(x, y)` returns true and
 *        `ccnxLink_Equals(y, z)` returns true,
 *        then  `ccnxLink_Equals(x, z)` must return true.
 *
 *   * It is consistent: for any non-null reference values x and y, multiple invocations of `ccnxLink_Equals(x, y)`
 *         consistently return true or consistently return false.
 *
 *   * For any non-null reference value x, `ccnxLink_Equals(x, NULL)` must return false.
 *
 *
 * @param [in] x A pointer to a `CCNxLink` instance.
 * @param [in] y A pointer to a `CCNxLink` instance.
 * @return `true` if the referenced `CCNxLink` instances are equal.
 *
 * Example:
 * @code
 * {
 *    CCNxLink *a = ccnxLink_Create();
 *    CCNxLink *b = ccnxLink_Create();
 *
 *    if (ccnxLink_Equals(a, b)) {
 *        // true
 *    } else {
 *        // false
 *    }
 * }
 * @endcode
 */
bool ccnxLink_Equals(const CCNxLink *x, const CCNxLink *y);

/**
 * Create a null-terminated string representation of the given `CCNxLink`.
 *
 * The returned value must be freed by the caller using {@link parcMemory_Deallocate()}.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance.
 * @return A pointer to null-terminated string of characters that must be freed by the caller by `parcMemory_Deallocate()`.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
char *ccnxLink_ToString(const CCNxLink *link);

/**
 * Increase the number of references to an instance of this object.
 *
 * Note that new instance is not created,
 * only that the given instance's reference count is incremented.
 * Discard the reference by invoking {@link ccnxLink_Release()}.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance to acquire.
 * @return The value of the input parameter @p link.
 *
 * Example:
 * @code
 * {
 *     ...
 *
 *     CCNxLink *link = ccnxLink_Acquire(instance);
 *
 *     ccnxLink_Release(&link);
 *
 * }
 * @endcode
 *
 * @see ccnxLink_Release
 */
CCNxLink *ccnxLink_Acquire(const CCNxLink *link);

/**
 * Release a previously acquired reference to the specified instance,
 * decrementing the reference count for the instance.
 *
 * The pointer to the instance is set to NULL as a side-effect of this function.
 *
 * If the invocation causes the last reference to the instance to be released,
 * the instance is deallocated and the instance's implementation will perform
 * additional cleanup and release other privately held references.
 *
 * @param [in,out] linkP A pointer to a pointer to the instance to release.
 *
 *
 * Example:
 * @code
 * {
 *     ...
 *
 *     CCNxLink *link = ccnxLink_Acquire(instance);
 *
 *     ccnxLink_Release(&link);
 *
 * }
 * @endcode
 */
void ccnxLink_Release(CCNxLink **linkP);

/**
 * Check that the pointer to the `CCNxLink` is valid. It should be non-null,
 * and any referenced data should also be valid.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance
 *
 *
 * Example:
 * @code
 * {
 *     ...
 *
 *     CCNxLink *link = ccnxLink_Acquire(instance);
 *
 *     ccnxLink_AssertValid(link);
 *
 * }
 * @endcode
 */
void ccnxLink_AssertValid(const CCNxLink *link);

/**
 * Determine if a `CCNxLink` instance is valid.
 *
 * @param [in] link  A pointer to a `CCNxLink` instance
 * @return true The instance is valid.
 * @return false The instance is invalid.
 *
 *
 * Example:
 * @code
 * {
 *     ...
 *
 *     CCNxLink *link = ccnxLink_Acquire(instance);
 *
 *     ccnxLink_AssertValid(link);
 *
 * }
 * @endcode
 */
bool ccnxLink_IsValid(const CCNxLink *link);
#endif // libccnx_ccnx_Link_h