blob: 30a998aa1d85b989f34b517265ebfb04e6a00d80 (
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
|
/*
* 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 ccnxCodecSchemaV1_MessageDecoder.h
* @brief <#Brief Description#>
*
* Decodes the CCNx message body for an Interest or a ContentObject.
*
* The current CPI Control packet does not use the MessageDecoder or MessageEncoder. It is handled
* entirely in the Packet{De,En}coder.
*
*/
#ifndef TransportRTA_ccnxCodecSchemaV1_MessageDecoder_h
#define TransportRTA_ccnxCodecSchemaV1_MessageDecoder_h
#include <stdbool.h>
#include <ccnx/common/internal/ccnx_TlvDictionary.h>
#include <ccnx/common/codec/ccnxCodec_TlvDecoder.h>
/**
* The decode a V1 message, maybe any message type
*
* The decoder should point to byte 0 of the message TLV
* The results are put in the provided dictionary.
* It is an error if the message does not extend to the end of
* the decoder.
*
* @param [in] decoder The decoder to parse
* @param [in] contentObjectDictionary 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 ccnxCodecSchemaV1MessageDecoder_Decode(CCNxCodecTlvDecoder *decoder, CCNxTlvDictionary *contentObjectDictionary);
#endif // TransportRTA_ccnxCodecSchemaV1_MessageDecoder_h
|
