blob: 6c3298a2c749870e18706d91d82e070092e0f85a (
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
|
/*
* 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_NameCodec.h
* @brief TLV codec for CCNx types
*
* <#Detailed Description#>
*
*/
#ifndef CCNxCodecSchemaV1_NameCodec_h
#define CCNxCodecSchemaV1_NameCodec_h
#include <ccnx/common/codec/ccnxCodec_TlvEncoder.h>
#include <ccnx/common/codec/ccnxCodec_TlvDecoder.h>
#include <ccnx/common/ccnx_Name.h>
/**
* Encodes the name to the TLV Encoder
*
* Will append the Name after the current encoder location
*
* @param [in] type The TLV type to use for the Name container
*
* @return bytes The number of bytes appended to the encoder
*
* Example:
* @code
* <#example#>
* @endcode
*/
size_t ccnxCodecSchemaV1NameCodec_Encode(CCNxCodecTlvEncoder *encoder, uint16_t type, const CCNxName *name);
/**
* Decode the buffer as a CCNxName beginning at the current position
*
* The buffer must be pointing to the beginnig of the "type". The decoder will
* verify that the type matches `type'. If it does not match, it will return NULL.
*
* @param [in] decoder The decoder
* @param [in] type The TLV type that the decoder should currently be pointing at
*
* @return non-null The CCNxName decoded
* @return null An error: either type did not match or some other error
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxName *ccnxCodecSchemaV1NameCodec_Decode(CCNxCodecTlvDecoder *decoder, uint16_t type);
/**
* The decoder points to the first byte of the Name "value"
*
* <#Paragraphs Of Explanation#>
*
* @param [in] decoder The Tlv Decoder pointing to the start of the Name value
* @param [in] length the length of the Name value
*
* @return non-null A parsed name
* @return null An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxName *ccnxCodecSchemaV1NameCodec_DecodeValue(CCNxCodecTlvDecoder *decoder, uint16_t length);
#endif // CCNxCodecSchemaV1_NameCodec_h
|
