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
|
/*
* 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.
*/
/**
* A type-safe wrapper for Missives around a {@link PARCDeque}. We only implement
* the subset of functions used.
*
*/
#include <config.h>
#include <stdio.h>
#include <LongBow/runtime.h>
#include <parc/algol/parc_Memory.h>
#include <parc/algol/parc_Deque.h>
#include <ccnx/forwarder/metis/messenger/metis_Missive.h>
#include <ccnx/forwarder/metis/messenger/metis_MissiveDeque.h>
struct metis_missive_deque {
PARCDeque *queue;
};
/**
* Create a `PARCDeque` instance with the default element equals function.
*
* The queue is created with no elements.
*
* The default element equals function is used by the `parcDeque_Equals` function and
* simply compares the values using the `==` operator.
* Users that need more sophisticated comparisons of the elements need to supply their own
* function via the `parcDeque_CreateCustom` function.
*
* @return non-NULL A pointer to a PARCDeque instance.
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
MetisMissiveDeque *
metisMissiveDeque_Create(void)
{
MetisMissiveDeque *missiveDeque = parcMemory_AllocateAndClear(sizeof(MetisMissiveDeque));
assertNotNull(missiveDeque, "parcMemory_AllocateAndClear(%zu) returned NULL", sizeof(MetisMissiveDeque));
missiveDeque->queue = parcDeque_Create();
return missiveDeque;
}
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
void
metisMissiveDeque_Release(MetisMissiveDeque **dequePtr)
{
assertNotNull(dequePtr, "Double pointer must be non-null");
assertNotNull(*dequePtr, "Double pointer must dereference to non-null");
MetisMissiveDeque *missiveDeque = *dequePtr;
// flush the queue
while (!parcDeque_IsEmpty(missiveDeque->queue)) {
MetisMissive *missive = metisMissiveDeque_RemoveFirst(missiveDeque);
metisMissive_Release(&missive);
}
parcDeque_Release(&missiveDeque->queue);
parcMemory_Deallocate((void **) &missiveDeque);
*dequePtr = NULL;
}
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
MetisMissiveDeque *
metisMissiveDeque_Append(MetisMissiveDeque *deque, MetisMissive *missive)
{
assertNotNull(deque, "Parameter deque must be non-null");
assertNotNull(missive, "Parameter missive must be non-null");
parcDeque_Append(deque->queue, missive);
return deque;
}
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
MetisMissive *
metisMissiveDeque_RemoveFirst(MetisMissiveDeque *deque)
{
assertNotNull(deque, "Parameter deque must be non-null");
return (MetisMissive *) parcDeque_RemoveFirst(deque->queue);
}
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
size_t
metisMissiveDeque_Size(const MetisMissiveDeque *deque)
{
assertNotNull(deque, "Parameter deque must be non-null");
return parcDeque_Size(deque->queue);
}
|
