aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/src/protocols/production_protocol.h
blob: 7366311eb01454bc8c1fe28b1b6c8d192805d7a4 (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
/*
 * 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/interfaces/callbacks.h>
#include <hicn/transport/interfaces/socket_producer.h>
#include <hicn/transport/interfaces/statistics.h>
#include <hicn/transport/utils/object_pool.h>
#include <implementation/socket.h>
#include <protocols/fec_base.h>
#include <protocols/fec_utils.h>
#include <utils/content_store.h>

#include <atomic>
#include <thread>

namespace transport {

namespace protocol {

using namespace core;

class ProductionProtocol : public Portal::ProducerCallback {
 public:
  ProductionProtocol(implementation::ProducerSocket *icn_socket);
  virtual ~ProductionProtocol();

  bool isRunning() { return is_running_; }

  virtual int start();
  virtual void stop();

  virtual void produce(ContentObject &content_object);
  virtual uint32_t produceStream(const Name &content_name,
                                 std::unique_ptr<utils::MemBuf> &&buffer,
                                 bool is_last = true,
                                 uint32_t start_offset = 0) = 0;
  virtual uint32_t produceStream(const Name &content_name,
                                 const uint8_t *buffer, size_t buffer_size,
                                 bool is_last = true,
                                 uint32_t start_offset = 0) = 0;
  virtual uint32_t produceDatagram(const Name &content_name,
                                   std::unique_ptr<utils::MemBuf> &&buffer) = 0;
  virtual uint32_t produceDatagram(const Name &content_name,
                                   const uint8_t *buffer,
                                   size_t buffer_size) = 0;

  void setOutputBufferSize(std::size_t size) { output_buffer_.setLimit(size); }
  std::size_t getOutputBufferSize() { return output_buffer_.getLimit(); }

  virtual void registerNamespaceWithNetwork(const Prefix &producer_namespace);
  const std::list<Prefix> &getNamespaces() const { return served_namespaces_; }

 protected:
  // Producer callback
  virtual void onInterest(core::Interest &i) override = 0;
  virtual void onError(std::error_code ec) override{};

  template <typename FECHandler, typename AllocatorHandler>
  void enableFEC(FECHandler &&fec_handler,
                 AllocatorHandler &&allocator_handler) {
    if (!fec_encoder_) {
      // Try to get FEC from environment
      if (const char *fec_str = std::getenv("TRANSPORT_FEC_TYPE")) {
        LOG(INFO) << "Using FEC " << fec_str;
        fec_type_ = fec::FECUtils::fecTypeFromString(fec_str);
      }

      if (fec_type_ == fec::FECType::UNKNOWN) {
        return;
      }

      fec_encoder_ = fec::FECUtils::getEncoder(fec_type_, 1);
      fec_encoder_->setFECCallback(std::forward<FECHandler>(fec_handler));
      fec_encoder_->setBufferCallback(
          std::forward<AllocatorHandler>(allocator_handler));
    }
  }

 protected:
  implementation::ProducerSocket *socket_;

  // Thread pool responsible for IO operations (send data / receive interests)
  std::vector<utils::EventThread> io_threads_;

  // TODO remove this thread
  std::thread listening_thread_;
  std::shared_ptr<Portal> portal_;
  std::atomic<bool> is_running_;
  interface::ProductionStatistics *stats_;
  std::unique_ptr<fec::ProducerFEC> fec_encoder_;

  // Callbacks
  interface::ProducerInterestCallback *on_interest_input_;
  interface::ProducerInterestCallback *on_interest_dropped_input_buffer_;
  interface::ProducerInterestCallback *on_interest_inserted_input_buffer_;
  interface::ProducerInterestCallback *on_interest_satisfied_output_buffer_;
  interface::ProducerInterestCallback *on_interest_process_;

  interface::ProducerContentObjectCallback *on_new_segment_;
  interface::ProducerContentObjectCallback *on_content_object_to_sign_;
  interface::ProducerContentObjectCallback *on_content_object_in_output_buffer_;
  interface::ProducerContentObjectCallback *on_content_object_output_;
  interface::ProducerContentObjectCallback
      *on_content_object_evicted_from_output_buffer_;

  interface::ProducerContentCallback *on_content_produced_;

  // Output buffer
  utils::ContentStore output_buffer_;

  // List ot routes served by current producer protocol
  std::list<Prefix> served_namespaces_;

  // Signature and manifest
  std::shared_ptr<auth::Signer> signer_;
  bool making_manifest_;

  bool is_async_;
  fec::FECType fec_type_;
};

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