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
|
/*
* 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.
*/
#ifndef __Metis__metis_TimeOrderedList__
#define __Metis__metis_TimeOrderedList__
#include <stdio.h>
#include <ccnx/forwarder/metis/core/metis_Message.h>
#include <ccnx/forwarder/metis/content_store/metis_ContentStoreEntry.h>
#include <parc/algol/parc_TreeRedBlack.h>
struct metis_timeordered_list;
typedef struct metis_timeordered_list MetisTimeOrderedList;
/**
* A signum function that takes two instances of MetisContentStoreEntrys and
* returns a value based on their relative values.
*/
typedef PARCTreeRedBlack_KeyCompare MetisTimeOrderList_KeyCompare;
/**
* Create a new instance of `MetisTimeOrderedList` that will maintain the order of its
* list items using the supplied `keyCompareFunction`.
*
* The newly created `MetisTimeOrderedList` must eventually be released by calling
* {@link metisTimeOrderedList_Release}.
*
* @param keyCompareFunction the signum comparison function to use to sort stored items.
* @return a new instance of `MetisTimeOrderList`.
* @return NULL if the new instance couldn't be created.
*
* Example:
* @code
* {
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
*
* ...
*
* metisTimeOrderedList_Release(&list);
* }
* @endcode
*
* @see metisTimeOrderedList_Release
* @see metisContentStoreEntry_CompareExpiryTime
* @see metisContentStoreEntry_CompareRecommendedCacheTime
*/
MetisTimeOrderedList *metisTimeOrderedList_Create(MetisTimeOrderList_KeyCompare *keyCompareFunction);
/**
* 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] listP A pointer to a pointer to the instance to release.
* Example:
* @code
* {
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
*
* ...
*
* metisTimeOrderedList_Release(&list);
* }
* @endcode
*/
void metisTimeOrderedList_Release(MetisTimeOrderedList **listP);
/**
* Add a {@link MetisContentStoreEntry} instance to the specified list. Note that a new refernece to
* the specified `storeEntry` is not acquired.
*
* @param list the list instance into which to add the specified storeEntry.
* @param storeEntry the storeEntry instance to add.
*
* Example:
* @code
* {
* MetisLogger *logger = metisLogger_Create(...);
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
* MetisLruList *lruList = metisLruList_Create();
* MetisMessage *message = metisMessage_CreateFromArray((uint8_t *) "\x00" "ehlo", 5, 111, 2, logger);
*
* MetisContentStoreEntry *entry = metisContentStoreEntry_Create(message, lruList, 2l, 1l);
*
* metisTimeOrderedList_Add(list, entry);
*
* metisTimeOrderedList_Release(&list);
*
* metisContentStoreEntry_Release(&entry);
* metisMessage_Release(&message);
* metisLruList_Destroy(&lruList);
* metisLogger_Release(&logger);
* }
* @endcode
* @see metisTimeOrderedList_Remove
*/
void metisTimeOrderedList_Add(MetisTimeOrderedList *list, MetisContentStoreEntry *storeEntry);
/**
* Remove a {@link MetisContentStoreEntry} instance from the specified list.
*
* @param list the list instance from which to remove the specified storeEntry.
* @param storeEntry the storeEntry instance to remove.
* @return true if the removal was succesful.
* @return false if the removal was not succesful.
*
* Example:
* @code
* {
* MetisLogger *logger = metisLogger_Create(...);
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
* MetisMessage *message = metisMessage_CreateFromArray((uint8_t *) "\x00" "ehlo", 5, 111, 2, logger);
*
* MetisContentStoreEntry *entry = metisContentStoreEntry_Create(message, NULL, 2l, 1l);
*
* metisTimeOrderedList_Add(list, entry);
*
* ...
*
* metisTimeOrderedList_Remove(list, entry);
* metisTimeOrderedList_Release(&list);
*
* metisContentStoreEntry_Release(&entry);
* metisMessage_Release(&message);
* metisLogger_Release(&logger);
* }
* @endcode
* @see metisTimeOrderedList_Add
*/
bool metisTimeOrderedList_Remove(MetisTimeOrderedList *list, MetisContentStoreEntry *storeEntry);
/**
* Return the oldest {@link MetisContentStoreEntry} instance in this list. That is, the one with the smallest
* time value.
*
* @param list the list instance from which to retrieve the oldest storeEntry.
* @param the oldest `MetisContentStoreEntry` in the list
* @param NULL if no `MetisContentStoreEntry` was available.
*
* Example:
* @code
* {
* MetisLogger *logger = metisLogger_Create(...);
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
* MetisLruList *lruList = metisLruList_Create();
* MetisMessage *message = metisMessage_CreateFromArray((uint8_t *) "\x00" "ehlo", 5, 111, 2, logger);
*
* MetisContentStoreEntry *entry = metisContentStoreEntry_Create(message, lruList, 2l, 1l);
*
* metisTimeOrderedList_Add(list, entry);
*
* MetisContentStoreEntry *oldest = metisTimeOrderedList_GetOldest(list);
*
* ...
*
* metisTimeOrderedList_Release(&list);
*
* metisContentStoreEntry_Release(&entry);
* metisMessage_Release(&message);
* metisLruList_Destroy(&lruList);
* metisLogger_Release(&logger);
* }
* @endcode
* @see metisTimeOrderedList_Remove
*/
MetisContentStoreEntry *metisTimeOrderedList_GetOldest(MetisTimeOrderedList *list);
/**
* Return the number of items currently stored in the list.
*
* @param list the `MetisTimeOrderedList` instance from which to retrieve the count.
* @return the number of items in the list.
*
* Example:
* @code
* {
* MetisLogger *logger = metisLogger_Create(...);
* MetisTimeOrderedList *list =
* metisTimeOrderedList_Create((MetisTimeOrderList_KeyCompare *) metisContentStoreEntry_CompareExpiryTime);
* MetisLruList *lruList = metisLruList_Create();
* MetisMessage *message = metisMessage_CreateFromArray((uint8_t *) "\x00" "ehlo", 5, 111, 2, logger);
*
* MetisContentStoreEntry *entry = metisContentStoreEntry_Create(message, lruList, 2l, 1l);
*
* metisTimeOrderedList_Add(list, entry);
*
* ...
* size_t numItemsInList = metisTimeOrderedList_Length(list);
* ...
*
* metisTimeOrderedList_Release(&list);
*
* metisContentStoreEntry_Release(&entry);
* metisMessage_Release(&message);
* metisLruList_Destroy(&lruList);
* metisLogger_Release(&logger);
* }
* @endcode
*/
size_t metisTimeOrderedList_Length(MetisTimeOrderedList *list);
#endif /* defined(__Metis__metis_TimeOrderedList__) */
|
