aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/includes/hicn/transport/interfaces/socket_producer.h
blob: 2627b313886f5573ca949cceb40eee718543708a (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * 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 <hicn/transport/auth/signer.h>
#include <hicn/transport/config.h>
#include <hicn/transport/core/asio_wrapper.h>
#include <hicn/transport/core/name.h>
#include <hicn/transport/core/prefix.h>
#include <hicn/transport/interfaces/callbacks.h>
#include <hicn/transport/interfaces/socket_options_default_values.h>
#include <hicn/transport/interfaces/socket_options_keys.h>
#include <hicn/transport/utils/event_thread.h>
#include <hicn/transport/utils/noncopyable.h>

namespace transport {

namespace implementation {
class ProducerSocket;
}

namespace interface {

using namespace core;

class ProducerSocket : private utils::NonCopyable {
 public:
  /**
   * @brief This class is used by the transport to notify events to the
   * application.
   */
  class Callback {
   public:
    /**
     * @brief This will invoked in an error occurred in the production protocol.
     *
     * @param ec - An error code describing the error.
     */
    virtual void produceError(const std::error_code &ec) noexcept = 0;
  };

  explicit ProducerSocket(
      int protocol = ProductionProtocolAlgorithms::BYTE_STREAM);

  explicit ProducerSocket(int protocol, ::utils::EventThread &worker);

  ProducerSocket(ProducerSocket &&other) noexcept;

  virtual ~ProducerSocket();

  void connect();

  bool isRunning();

  void registerPrefix(const Prefix &producer_namespace);

  uint32_t produceStream(const Name &content_name, const uint8_t *buffer,
                         size_t buffer_size, bool is_last = true,
                         uint32_t start_offset = 0);

  uint32_t produceStream(const Name &content_name,
                         std::unique_ptr<utils::MemBuf> &&buffer,
                         bool is_last = true, uint32_t start_offset = 0);

  uint32_t produceDatagram(const Name &content_name, const uint8_t *buffer,
                           size_t buffer_size);

  uint32_t produceDatagram(const Name &content_name,
                           std::unique_ptr<utils::MemBuf> &&buffer);

  void produce(ContentObject &content_object);

  void sendMapme();

  void stop();

  void start();

  asio::io_service &getIoService();

  int setSocketOption(int socket_option_key, Callback *socket_option_value);

  int setSocketOption(int socket_option_key, uint32_t socket_option_value);

  int setSocketOption(int socket_option_key,
                      std::nullptr_t socket_option_value);

  int setSocketOption(int socket_option_key, bool socket_option_value);

  int setSocketOption(int socket_option_key, Name *socket_option_value);

  int setSocketOption(int socket_option_key,
                      std::list<Prefix> socket_option_value);

  int setSocketOption(int socket_option_key,
                      ProducerContentObjectCallback socket_option_value);

  int setSocketOption(int socket_option_key,
                      ProducerInterestCallback socket_option_value);

  int setSocketOption(int socket_option_key,
                      ProducerContentCallback socket_option_value);

  int setSocketOption(int socket_option_key,
                      auth::CryptoHashType socket_option_value);

  int setSocketOption(int socket_option_key,
                      auth::CryptoSuite socket_option_value);

  int setSocketOption(int socket_option_key,
                      const std::shared_ptr<auth::Signer> &socket_option_value);

  int setSocketOption(
      int socket_option_key,
      const std::shared_ptr<auth::Verifier> &socket_option_value);

  int setSocketOption(int socket_option_key,
                      const std::string &socket_option_value);

  int getSocketOption(int socket_option_key, uint32_t &socket_option_value);

  int getSocketOption(int socket_option_key, bool &socket_option_value);

  int getSocketOption(int socket_option_key,
                      std::list<Prefix> &socket_option_value);

  int getSocketOption(int socket_option_key,
                      ProducerContentObjectCallback **socket_option_value);

  int getSocketOption(int socket_option_key,
                      ProducerContentCallback **socket_option_value);

  int getSocketOption(int socket_option_key,
                      ProducerInterestCallback **socket_option_value);

  int getSocketOption(int socket_option_key,
                      auth::CryptoHashType &socket_option_value);

  int getSocketOption(int socket_option_key,
                      auth::CryptoSuite &socket_option_value);

  int getSocketOption(int socket_option_key,
                      std::shared_ptr<auth::Signer> &socket_option_value);

  int getSocketOption(int socket_option_key,
                      std::shared_ptr<auth::Verifier> &socket_option_value);

  int getSocketOption(int socket_option_key, std::string &socket_option_value);

 protected:
  ProducerSocket(bool);
  std::unique_ptr<implementation::ProducerSocket> socket_;
};

}  // namespace interface

}  // namespace transport