aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/src/protocols/protocol.h
blob: db4524133800e811caf02accefe18fbe2e8bb095 (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
/*
 * 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 <atomic>

#include <hicn/transport/interfaces/callbacks.h>
#include <hicn/transport/interfaces/socket_consumer.h>
#include <hicn/transport/interfaces/statistics.h>
#include <hicn/transport/utils/object_pool.h>

#include <implementation/socket.h>
#include <protocols/data_processing_events.h>
#include <protocols/indexer.h>
#include <protocols/packet_manager.h>
#include <protocols/reassembly.h>

namespace transport {

namespace protocol {

using namespace core;

class IndexVerificationManager;

using ReadCallback = interface::ConsumerSocket::ReadCallback;

class TransportProtocolCallback {
  virtual void onContentObject(const core::Interest &interest,
                               const core::ContentObject &content_object) = 0;
  virtual void onTimeout(const core::Interest &interest) = 0;
};

class TransportProtocol : public implementation::BasePortal::ConsumerCallback,
                          public PacketManager<Interest>,
                          public ContentObjectProcessingEventCallback {
  static constexpr std::size_t interest_pool_size = 4096;

  friend class ManifestIndexManager;

 public:
  TransportProtocol(implementation::ConsumerSocket *icn_socket,
                    Reassembly *reassembly_protocol);

  virtual ~TransportProtocol() = default;

  TRANSPORT_ALWAYS_INLINE bool isRunning() { return is_running_; }

  virtual int start();

  virtual void stop();

  virtual void resume();

  virtual bool verifyKeyPackets() = 0;

  virtual void scheduleNextInterests() = 0;

  // Events generated by the indexing
  virtual void onContentReassembled(std::error_code ec);
  virtual void onPacketDropped(
      Interest::Ptr &&interest,
      ContentObject::Ptr &&content_object) override = 0;
  virtual void onReassemblyFailed(std::uint32_t missing_segment) override = 0;

 protected:
  // Consumer Callback
  virtual void reset() = 0;
  virtual void onContentObject(Interest::Ptr &&i,
                               ContentObject::Ptr &&c) override = 0;
  virtual void onTimeout(Interest::Ptr &&i) override = 0;
  virtual void onError(std::error_code ec) override {}

 protected:
  implementation::ConsumerSocket *socket_;
  std::unique_ptr<Reassembly> reassembly_protocol_;
  std::unique_ptr<IndexManager> index_manager_;
  std::shared_ptr<implementation::BasePortal> portal_;
  std::atomic<bool> is_running_;
  // True if it si the first time we schedule an interest
  std::atomic<bool> is_first_;
  interface::TransportStatistics *stats_;

  // Callbacks
  interface::ConsumerInterestCallback *on_interest_retransmission_;
  interface::ConsumerInterestCallback *on_interest_output_;
  interface::ConsumerInterestCallback *on_interest_timeout_;
  interface::ConsumerInterestCallback *on_interest_satisfied_;
  interface::ConsumerContentObjectCallback *on_content_object_input_;
  interface::ConsumerContentObjectVerificationCallback
      *on_content_object_verification_;
  interface::ConsumerContentObjectCallback *on_content_object_;
  interface::ConsumerTimerCallback *stats_summary_;
  interface::ConsumerContentObjectVerificationFailedCallback
      *verification_failed_callback_;
  ReadCallback *on_payload_;
};

}  // end namespace protocol
}  // end namespace transport