summaryrefslogtreecommitdiffstats
path: root/libtransport/src/protocols/reassembly.h
blob: b0879201d139b26dc5fb9c189368c5f1dfe4034d (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
/*
 * Copyright (c) 2021 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 <core/facade.h>

namespace transport {

namespace implementation {
class ConsumerReadCallback;
class ConsumerSocket;
}  // namespace implementation

namespace protocol {

class TransportProtocol;
class Indexer;

// Forward Declaration
class ManifestManager;

class Reassembly {
 public:
  class ContentReassembledCallback {
   public:
    virtual void onContentReassembled(const std::error_code &ec) = 0;
  };

  Reassembly(implementation::ConsumerSocket *icn_socket,
             TransportProtocol *transport_protocol)
      : reassembly_consumer_socket_(icn_socket),
        transport_protocol_(transport_protocol) {}

  virtual ~Reassembly() = default;

  /**
   * Handle reassembly of content object.
   */
  virtual void reassemble(core::ContentObject &content_object) = 0;

  /**
   * Handle reassembly of content object.
   */
  virtual void reassemble(utils::MemBuf &buffer, uint32_t suffix) = 0;

  /**
   * Handle reassembly of manifest
   */
  virtual void reassemble(
      std::unique_ptr<core::ContentObjectManifest> &&manifest) = 0;

  /**
   * Reset reassembler for new round
   */
  virtual void reInitialize() = 0;

  /**
   * Use indexer to get next segments to reassembly
   */
  virtual void setIndexer(Indexer *indexer) { indexer_verifier_ = indexer; }

  /**
   * Decide if it is required to pass to application buffers whose verification
   * has been delayed (e.g. because the manifest is missing). False by default.
   */
  virtual bool reassembleUnverified() { return false; }

 protected:
  /**
   * Notify application there is data to read.
   */
  virtual void notifyApplication();

 protected:
  implementation::ConsumerSocket *reassembly_consumer_socket_;
  TransportProtocol *transport_protocol_;
  Indexer *indexer_verifier_;
  std::unique_ptr<utils::MemBuf> read_buffer_;
};

}  // namespace protocol

}  // end namespace transport