blob: a4d2010cc709abe2c4f5c29273f6fff0c467e96c (
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
|
/*
* 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_ChunkingFacade.h
* @brief <#Brief Description#>
*
* <#Detailed Description#>
*
*/
#ifndef libccnx_ccnx_ChunkingFacadeV1_h
#define libccnx_ccnx_ChunkingFacadeV1_h
#include <ccnx/common/internal/ccnx_TlvDictionary.h>
/**
* Determines if an EndChunkNumber exists in the metadata
*
* Compatible with V0 and V1 schemas.
*
* @param [in] contentObjectDictionary A dictionary to check
*
* @return false There is no EndChunkNumber specified or the dictinoary is not a ContentObject
* @return true There is an EndChunkNumber specified
*
* Example:
* @code
* static PARCElasticBuffer *
* _ccnxContentObjectFacade_CreateFinalBlockId(const CCNxTlvDictionary *contentObjectDictionary)
* {
* if (ccnxChunkingFacade_HasEndChunkNumber(contentObjectDictionary)) {
* uint64_t endChunkNumber = ccnxChunkingFacade_GetEndChunkNumber(contentObjectDictionary);
* PARCElasticBuffer *fbid = _ccnxContentObjectFacade_EncodeFinalBlockId(endChunkNumber);
* return fbid;
* }
* return NULL;
* }
* @endcode
*/
bool ccnxChunkingFacadeV1_HasEndChunkNumber(const CCNxTlvDictionary *contentObjectDictionary);
/**
* Retrieves the end chunk number
*
* Retieves the end chunk number as an unsigned 64-bit integer.
* This function will trapIllegalValue if there is not an EndChunkNumber present.
* The EndChunkNumber is the chunk number of the last Content Object in a chunked series.
*
* @param [in] contentObjectDictionary A dictionary to check
*
* @return number The ending chunk number
*
* Example:
* @code
* static PARCElasticBuffer *
* _ccnxContentObjectFacade_CreateFinalBlockId(const CCNxTlvDictionary *contentObjectDictionary)
* {
* if (ccnxChunkingFacade_HasEndChunkNumber(contentObjectDictionary)) {
* uint64_t endChunkNumber = ccnxChunkingFacade_GetEndChunkNumber(contentObjectDictionary);
* PARCElasticBuffer *fbid = _ccnxContentObjectFacade_EncodeFinalBlockId(endChunkNumber);
* return fbid;
* }
* return NULL;
* }
* @endcode
*/
uint64_t ccnxChunkingFacadeV1_GetEndChunkNumber(const CCNxTlvDictionary *contentObjectDictionary);
/**
* Sets the EndChunkNumber of a ContentObject
*
* The dictionary must be a ContentObject, otherwise this function will trapIllegalValue.
* If an EndChunkNumber already exits, will not update but return false.
*
* @param [in] contentObjectDictionary A dictionary to check
* @param [in] endChunkNumber The ending chunk number
*
* @return true The value was set in the dictionary
* @return false A failure (likely value already set)
*
* Example:
* @code
* {
* CCNxTlvDictionary *obj = ccnxContentObjectFacade_Create(...);
* ccnxChunkingFacade_SetEndChunkNumber(obj, 74);
* }
* @endcode
*/
bool ccnxChunkingFacadeV1_SetEndChunkNumber(CCNxTlvDictionary *contentObjectDictionary, uint64_t endChunkNumber);
#endif // libccnx_ccnx_ChunkingFacadeV1_h
|
