summaryrefslogtreecommitdiffstats
path: root/libtransport/src/hicn/transport/protocols/protocol.h
blob: 56c57e0258af6a7685993c3c57cf178fe24f90cc (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
/*
 * 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/socket.h>
#include <hicn/transport/utils/object_pool.h>
#include <hicn/transport/utils/sharable_vector.h>

namespace transport {

namespace protocol {

using namespace core;

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 interface::BasePortal::ConsumerCallback {
  static constexpr std::size_t interest_pool_size = 4096;

 public:
  TransportProtocol(interface::BaseSocket *icn_socket);

  virtual ~TransportProtocol();

  void updatePortal();

  bool isRunning();

  virtual void start(utils::SharableVector<uint8_t> &content_buffer) = 0;

  virtual void stop() = 0;

  virtual void resume() = 0;

 protected:
  virtual void increasePoolSize(std::size_t size = interest_pool_size);

  TRANSPORT_ALWAYS_INLINE Interest::Ptr getInterest() {
    auto result = interest_pool_.get();

    while (TRANSPORT_EXPECT_FALSE(!result.first)) {
      // Add packets to the pool
      increasePoolSize();
      result = interest_pool_.get();
    }

    return std::move(result.second);
  }
  // Consumer Callback
  virtual void onContentObject(Interest::Ptr &&i, ContentObject::Ptr &&c) = 0;
  virtual void onTimeout(Interest::Ptr &&i) = 0;

 protected:
  interface::ConsumerSocket *socket_;
  std::shared_ptr<interface::BasePortal> portal_;
  volatile bool is_running_;
  utils::ObjectPool<Interest> interest_pool_;
};

}  // end namespace protocol

}  // end namespace transport