summaryrefslogtreecommitdiffstats
path: root/libtransport/src/protocols/incremental_indexer.h
blob: 20c5e4759308031157657e345cf0868c376e10f3 (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
/*
 * 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/errors/runtime_exception.h>
#include <hicn/transport/errors/unexpected_manifest_exception.h>
#include <hicn/transport/utils/literals.h>

#include <protocols/indexer.h>
#include <protocols/reassembly.h>
#include <protocols/verification_manager.h>

#include <deque>

namespace transport {

namespace interface {
class ConsumerSocket;
}

namespace protocol {

class Reassembly;
class TransportProtocol;

class IncrementalIndexer : public Indexer {
 public:
  IncrementalIndexer(implementation::ConsumerSocket *icn_socket,
                     TransportProtocol *transport, Reassembly *reassembly)
      : socket_(icn_socket),
        reassembly_(reassembly),
        transport_protocol_(transport),
        final_suffix_(std::numeric_limits<uint32_t>::max()),
        first_suffix_(0),
        next_download_suffix_(0),
        next_reassembly_suffix_(0),
        verification_manager_(
            std::make_unique<SignatureVerificationManager>(icn_socket)) {
    if (reassembly_) {
      reassembly_->setIndexer(this);
    }
  }

  IncrementalIndexer(const IncrementalIndexer &) = delete;

  IncrementalIndexer(IncrementalIndexer &&other)
      : socket_(other.socket_),
        reassembly_(other.reassembly_),
        transport_protocol_(other.transport_protocol_),
        final_suffix_(other.final_suffix_),
        first_suffix_(other.first_suffix_),
        next_download_suffix_(other.next_download_suffix_),
        next_reassembly_suffix_(other.next_reassembly_suffix_),
        verification_manager_(std::move(other.verification_manager_)) {
    if (reassembly_) {
      reassembly_->setIndexer(this);
    }
  }

  /**
   *
   */
  virtual ~IncrementalIndexer() {}

  TRANSPORT_ALWAYS_INLINE virtual void reset(
      std::uint32_t offset = 0) override {
    final_suffix_ = std::numeric_limits<uint32_t>::max();
    next_download_suffix_ = offset;
    next_reassembly_suffix_ = offset;
  }

  /**
   * Retrieve from the manifest the next suffix to retrieve.
   */
  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextSuffix() override {
    return next_download_suffix_ <= final_suffix_ ? next_download_suffix_++
                                                  : IndexManager::invalid_index;
  }

  TRANSPORT_ALWAYS_INLINE virtual void setFirstSuffix(
      uint32_t suffix) override {
    first_suffix_ = suffix;
  }

  /**
   * Retrive the next segment to be reassembled.
   */
  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextReassemblySegment() override {
    return next_reassembly_suffix_ <= final_suffix_
               ? next_reassembly_suffix_++
               : IndexManager::invalid_index;
  }

  TRANSPORT_ALWAYS_INLINE virtual bool isFinalSuffixDiscovered() override {
    return final_suffix_ != std::numeric_limits<uint32_t>::max();
  }

  TRANSPORT_ALWAYS_INLINE virtual uint32_t getFinalSuffix() override {
    return final_suffix_;
  }

  void onContentObject(core::Interest::Ptr &&interest,
                       core::ContentObject::Ptr &&content_object) override;

  TRANSPORT_ALWAYS_INLINE void setReassembly(Reassembly *reassembly) {
    reassembly_ = reassembly;

    if (reassembly_) {
      reassembly_->setIndexer(this);
    }
  }

  TRANSPORT_ALWAYS_INLINE bool onKeyToVerify() override {
    return verification_manager_->onKeyToVerify();
  }

 protected:
  implementation::ConsumerSocket *socket_;
  Reassembly *reassembly_;
  TransportProtocol *transport_protocol_;
  uint32_t final_suffix_;
  uint32_t first_suffix_;
  uint32_t next_download_suffix_;
  uint32_t next_reassembly_suffix_;
  std::unique_ptr<VerificationManager> verification_manager_;
};

}  // end namespace protocol

}  // end namespace transport