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
|
/*
* 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 vegas_private.h
* @brief <#Brief Description#>
*
* <#Detailed Description#>
*
*/
#ifndef Libccnx_vegas_private_h
#define Libccnx_vegas_private_h
#include <ccnx/common/ccnx_Name.h>
#include <ccnx/common/internal/ccnx_ContentObjectInterface.h>
typedef uint64_t segnum_t;
struct vegas_session;
typedef struct vegas_session VegasSession;
struct vegas_connection_state;
typedef struct vegas_connection_state VegasConnectionState;
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [in] fc An allocated Vegas flow controller
* @param [in] conn The RTA connection owning the flow
* @param [in] basename The name without a chunk number
* @param [in] begin The chunk number to begin requesting at
* @param [in] interestInterface The {@link CCNxInterestInterface} to use to generate new Interests
* @param [in] lifetime The default lifetime, in milli-seconds, to use for generated Interests
* @param [in] keyIdRestriction The KeyIdRestriction, if any, from the originating Interest
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
VegasSession *vegasSession_Create(VegasConnectionState *fc, RtaConnection *conn, CCNxName *basename,
segnum_t begin, CCNxInterestInterface *interestInterface, uint32_t lifetime,
PARCBuffer *keyIdRestriction);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
void vegasSession_Destroy(VegasSession **sessionPtr);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
int vegasSession_Start(VegasSession *session);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
int vegasSession_Pause(VegasSession *session);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
int vegasSession_Resume(VegasSession *session);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
int vegasSession_Seek(VegasSession *session, segnum_t absolutePosition);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
int vegasSession_ReceiveContentObject(VegasSession *session, TransportMessage *tm);
/**
* Tell a session that there was a state change in its connection
*
* The caller should ensure that the session's connection is the right one by
* using {@link vegasSession_GetConnectionId}.
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void vegasSession_StateChanged(VegasSession *session);
/**
* Returns the connection id used by the session
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
unsigned vegasSession_GetConnectionId(VegasSession *session);
/**
* <#One Line Description#>
*
* Called by a session when it is done
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
void vegas_EndSession(VegasConnectionState *fc, VegasSession *session);
#endif // Libccnx_vegas_private_h
|
