aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/src/hicn/transport/core/manifest_format.h
blob: 00782f14d287a2c420631940b96b6f84bac1abb6 (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
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
/*
 * Copyright (c) 2017-2019 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.
 */

#pragma once

#include <hicn/transport/core/name.h>
#include <hicn/transport/utils/crypto_hasher.h>

#include <cinttypes>
#include <type_traits>
#include <unordered_map>

namespace transport {

namespace core {

enum class ManifestFields : uint8_t {
  VERSION,
  HASH_ALGORITHM,
  SEGMENT_CALCULATION_STRATEGY,
  FINAL_MANIFEST,
  NAME_HASH_LIST,
  BASE_NAME
};

enum class ManifestVersion : uint8_t {
  VERSION_1 = 1,
};

enum class ManifestType : uint8_t {
  INLINE_MANIFEST = 1,
  FINAL_CHUNK_NUMBER = 2,
  FLIC_MANIFEST = 3,
};

enum class HashAlgorithm : uint8_t {
  SHA_256 = static_cast<uint8_t>(utils::CryptoHashType::SHA_256),
  SHA_512 = static_cast<uint8_t>(utils::CryptoHashType::SHA_512),
  CRC32C = static_cast<uint8_t>(utils::CryptoHashType::CRC32C),
};

enum class NextSegmentCalculationStrategy : uint8_t {
  INCREMENTAL = 1,
};

template <typename T>
struct format_traits {
  using Encoder = typename T::Encoder;
  using Decoder = typename T::Decoder;
  using HashType = typename T::HashType;
  using HashList = typename T::HashList;
};

class Packet;

template <typename Implementation>
class ManifestEncoder {
 public:
  virtual ~ManifestEncoder() = default;

  ManifestEncoder encode() {
    return static_cast<Implementation &>(*this).encodeImpl();
  }

  ManifestEncoder &clear() {
    return static_cast<Implementation &>(*this).clearImpl();
  }

  ManifestEncoder &setManifestType(ManifestType type) {
    return static_cast<Implementation &>(*this).setManifestTypeImpl(type);
  }

  ManifestEncoder &setHashAlgorithm(HashAlgorithm hash) {
    return static_cast<Implementation &>(*this).setHashAlgorithmImpl(hash);
  }

  ManifestEncoder &setFinalChunkNumber(uint32_t final_chunk) {
    return static_cast<Implementation &>(*this).setFinalChunkImpl(final_chunk);
  }

  ManifestEncoder &setNextSegmentCalculationStrategy(
      NextSegmentCalculationStrategy strategy) {
    return static_cast<Implementation &>(*this)
        .setNextSegmentCalculationStrategyImpl(strategy);
  }

  template <
      typename T,
      typename = std::enable_if_t<std::is_same<
          std::remove_const_t<std::remove_reference_t<T>>, core::Name>::value>>
  ManifestEncoder &setBaseName(T &&name) {
    return static_cast<Implementation &>(*this).setBaseNameImpl(name);
  }

  template <typename Hash>
  ManifestEncoder &addSuffixAndHash(uint32_t suffix, Hash &&hash) {
    return static_cast<Implementation &>(*this).addSuffixAndHashImpl(
        suffix, std::forward<Hash &&>(hash));
  }

  ManifestEncoder &setIsFinalManifest(bool is_last) {
    return static_cast<Implementation &>(*this).setIsFinalManifestImpl(is_last);
  }

  ManifestEncoder &setVersion(ManifestVersion version) {
    return static_cast<Implementation &>(*this).setVersionImpl(version);
  }

  std::size_t estimateSerializedLength(std::size_t number_of_entries) {
    return static_cast<Implementation &>(*this).estimateSerializedLengthImpl(
        number_of_entries);
  }

  ManifestEncoder &update() {
    return static_cast<Implementation &>(*this).updateImpl();
  }

  ManifestEncoder &setFinalBlockNumber(std::uint32_t final_block_number) {
    return static_cast<Implementation &>(*this).setFinalBlockNumberImpl(
        final_block_number);
  }

  static std::size_t getManifestHeaderSize() {
    return Implementation::getManifestHeaderSizeImpl();
  }
};

template <typename Implementation>
class ManifestDecoder {
 public:
  virtual ~ManifestDecoder() = default;

  ManifestDecoder &clear() {
    return static_cast<Implementation &>(*this).clearImpl();
  }

  void decode() { static_cast<Implementation &>(*this).decodeImpl(); }

  ManifestType getManifestType() const {
    return static_cast<const Implementation &>(*this).getManifestTypeImpl();
  }

  HashAlgorithm getHashAlgorithm() const {
    return static_cast<const Implementation &>(*this).getHashAlgorithmImpl();
  }

  uint32_t getFinalChunkNumber() const {
    return static_cast<const Implementation &>(*this).getFinalChunkImpl();
  }

  NextSegmentCalculationStrategy getNextSegmentCalculationStrategy() const {
    return static_cast<const Implementation &>(*this)
        .getNextSegmentCalculationStrategyImpl();
  }

  core::Name getBaseName() const {
    return static_cast<const Implementation &>(*this).getBaseNameImpl();
  }

  auto getSuffixHashList() {
    return static_cast<Implementation &>(*this).getSuffixHashListImpl();
  }

  bool getIsFinalManifest() const {
    return static_cast<const Implementation &>(*this).getIsFinalManifestImpl();
  }

  ManifestVersion getVersion() const {
    return static_cast<const Implementation &>(*this).getVersionImpl();
  }

  std::size_t estimateSerializedLength(std::size_t number_of_entries) const {
    return static_cast<const Implementation &>(*this)
        .estimateSerializedLengthImpl(number_of_entries);
  }

  uint32_t getFinalBlockNumber() const {
    return static_cast<const Implementation &>(*this).getFinalBlockNumberImpl();
  }
};

}  // namespace core

}  // namespace transport