blob: 5d15f40ba2ffe35158d7b91aec377b3478750b82 (
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
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
|
/*
* 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 Libccnx_ccnxCodecSchemaV1_FixedHeaderDecoder_h
#define Libccnx_ccnxCodecSchemaV1_FixedHeaderDecoder_h
#include <stdbool.h>
#include <parc/algol/parc_Buffer.h>
#include <ccnx/common/internal/ccnx_TlvDictionary.h>
#include <ccnx/common/codec/ccnxCodec_TlvDecoder.h>
/**
* The decode a V1 fixed header
*
* The decoder should point to byte 0 of the Fixed Header.
* It will be advanced to the first byte following it.
* The results are put in the provided.
*
* @param [in] decoder The decoder to parse
* @param [in] dictionary The results go directly in to the provided dictionary.
*
* @return true Fully parsed interest, no errors
* @return false Error decoding, decoder is left pointing to the first byte of the error
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool ccnxCodecSchemaV1FixedHeaderDecoder_Decode(CCNxCodecTlvDecoder *decoder, CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the version
*
* <#Paragraphs Of Explanation#>
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The Version
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetVersion(CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the PacketType
*
* <#Paragraphs Of Explanation#>
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The PacketType
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetPacketType(CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the PacketLength
*
* The PacketLength is measured from byte 0 to the end of the packet
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The packet length (in host byte order)
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetPacketLength(CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the HeaderLength
*
* In a version 1 packet, the header length includes the fixed header. It is measured from
* byte 0 to the end of the hop-by-hop headers.
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The header length
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetHeaderLength(CCNxTlvDictionary *packetDictionary);
/**
* Returns the bytes of the optional headers
*
* Computes ccnxCodecSchemaV1FixedHeaderDecoder_GetHeaderLength() - sizeof(fixedHeader)
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @retval non-negative The length of the optional headers
* @retval negative An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetOptionalHeaderLength(CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the ReturnCode of an Interest or InterestReturn
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The Return Code
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetReturnCode(CCNxTlvDictionary *packetDictionary);
/**
* A convenience function to return the header Flags
*
* @param [in] fixedHeaderDictionary The FixedHeader dictionary
*
* @return positive The flags
* @return -1 The field does not exist
*
* Example:
* @code
* <#example#>
* @endcode
*/
int ccnxCodecSchemaV1FixedHeaderDecoder_GetFlags(CCNxTlvDictionary *packetDictionary);
#endif // Libccnx_ccnxCodecSchemaV1_FixedHeaderDecoder_h
|
