aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-light/src/processor/fibEntryList.h
blob: 0f606643523674e0d2ef7ac966e586354f3b8756 (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
/*
 * Copyright (c) 2017-2019 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 fibEntryList.h
 * @brief A typesafe list of FibEntry
 *
 * <#Detailed Description#>
 *
 */

#ifndef fibEntryList_h
#define fibEntryList_h

#include <src/processor/fibEntry.h>

struct fib_entry_list;
typedef struct fib_entry_list FibEntryList;

/**
 * Creates an emtpy FIB entry list
 *
 * Must be destroyed with fibEntryList_Destroy.
 *
 * @retval non-null An allocated FibEntryList
 * @retval null An error
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
FibEntryList *fibEntryList_Create(void);

/**
 * @function FibEntryList_Detroy
 * @abstract Destroys the list and all entries.
 * @discussion
 *   <#Discussion#>
 *
 * @param <#param1#>
 */
void fibEntryList_Destroy(FibEntryList **listPtr);

/**
 * @function fibEntryList_Append
 * @abstract Will store a reference counted copy of the entry.
 * @discussion
 *   Will create and store a reference counted copy.  You keep ownership
 *   of the parameter <code>fibEntry</code>.
 *
 * @param <#param1#>
 * @return <#return#>
 */
void fibEntryList_Append(FibEntryList *list, FibEntry *fibEntry);

/**
 * Returns the number of entries in the list
 *
 * <#Paragraphs Of Explanation#>
 *
 * @param [in] list An allocated FibEntryList
 *
 * @retval number The number of entries in the list
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
size_t fibEntryList_Length(const FibEntryList *list);

/**
 * @function fibEntryList_Get
 * @abstract Gets an element.  This is the internal reference, do not destroy.
 * @discussion
 *   Returns an internal reference from the list.  You must not destroy it.
 *   Will assert if you go off the end of the list.
 *
 * @param <#param1#>
 * @return <#return#>
 */
const FibEntry *fibEntryList_Get(const FibEntryList *list, size_t index);
#endif  // fibEntryList_h