socket_consumer.h

/*
 * 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/auth/verifier.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>
 
#define CONSUMER_FINISHED 0
#define CONSUMER_BUSY 1
#define CONSUMER_RUNNING 2
 
namespace transport {
 
namespace implementation {
class ConsumerSocket;
}
 
namespace interface {
 
using namespace core;
 
class ConsumerSocket {
 public:
  class ReadCallback {
   public:
    virtual ~ReadCallback() = default;
 
    virtual bool isBufferMovable() noexcept { return true; }
 
    virtual void getReadBuffer(uint8_t **application_buffer,
                               size_t *max_length) = 0;
 
    virtual void readDataAvailable(size_t length) noexcept = 0;
 
    virtual size_t maxBufferSize() const { return 64 * 1024; }
 
    virtual void readBufferAvailable(
        std::unique_ptr<utils::MemBuf> &&buffer) noexcept {}
 
    virtual void readError(const std::error_code ec) noexcept = 0;
 
    virtual void readSuccess(std::size_t total_size) noexcept = 0;
  };
 
  explicit ConsumerSocket(int protocol);
 
  explicit ConsumerSocket(int protocol, asio::io_service &io_service);
 
  ~ConsumerSocket();
 
  void connect();
 
  bool isRunning();
 
  int consume(const Name &name);
  int asyncConsume(const Name &name);
 
  void stop();
 
  void resume();
 
  asio::io_service &getIoService();
 
  int setSocketOption(int socket_option_key, ReadCallback *socket_option_value);
 
  int getSocketOption(int socket_option_key,
                      ReadCallback **socket_option_value);
 
  int setSocketOption(int socket_option_key, double 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,
                      ConsumerContentObjectCallback socket_option_value);
 
  int setSocketOption(int socket_option_key,
                      ConsumerInterestCallback socket_option_value);
 
  int setSocketOption(int socket_option_key,
                      interface::IcnObserver *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 setSocketOption(int socket_option_key,
                      ConsumerTimerCallback socket_option_value);
 
  int getSocketOption(int socket_option_key, double &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, Name **socket_option_value);
 
  int getSocketOption(int socket_option_key,
                      ConsumerContentObjectCallback **socket_option_value);
 
  int getSocketOption(int socket_option_key,
                      ConsumerInterestCallback **socket_option_value);
 
  int getSocketOption(int socket_option_key, IcnObserver **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);
 
  int getSocketOption(int socket_option_key,
                      ConsumerTimerCallback **socket_option_value);
 
  int getSocketOption(int socket_option_key,
                      interface::TransportStatistics **socket_option_value);
 
 protected:
  ConsumerSocket();
  std::unique_ptr<implementation::ConsumerSocket> socket_;
};
 
}  // namespace interface
 
}  // end namespace transport