portal.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/core/asio_wrapper.h>
#include <hicn/transport/core/content_object.h>
#include <hicn/transport/core/interest.h>
#include <hicn/transport/core/prefix.h>
 
#include <functional>
 
#define UNSET_CALLBACK 0
 
namespace transport {
 
namespace interface {
 
template <typename PrefixType>
class BasicBindConfig {
  static_assert(std::is_same<core::Prefix, PrefixType>::value,
                "Prefix must be a Prefix type.");
 
  const uint32_t standard_cs_reserved = 5000;
 
 public:
  template <typename T>
  BasicBindConfig(T &&prefix)
      : prefix_(std::forward<T &&>(prefix)),
        content_store_reserved_(standard_cs_reserved) {}
 
  template <typename T>
  BasicBindConfig(T &&prefix, uint32_t cs_reserved)
      : prefix_(std::forward<T &&>(prefix)),
        content_store_reserved_(cs_reserved) {}
 
  TRANSPORT_ALWAYS_INLINE const PrefixType &prefix() const { return prefix_; }
 
  TRANSPORT_ALWAYS_INLINE uint32_t csReserved() const {
    return content_store_reserved_;
  }
 
 private:
  PrefixType prefix_;
  uint32_t content_store_reserved_;
};
 
using BindConfig = BasicBindConfig<core::Prefix>;
 
class Portal {
 public:
  class ConsumerCallback {
   public:
    virtual void onContentObject(core::Interest &i, core::ContentObject &c) = 0;
    virtual void onTimeout(core::Interest::Ptr &i, const core::Name &n) = 0;
    virtual void onError(std::error_code ec) = 0;
  };
 
  class ProducerCallback {
   public:
    virtual void onInterest(core::Interest &i) = 0;
    virtual void onError(std::error_code ec) = 0;
  };
 
  using OnContentObjectCallback =
      std::function<void(core::Interest &, core::ContentObject &)>;
  using OnInterestTimeoutCallback =
      std::function<void(core::Interest::Ptr &, const core::Name &)>;
 
  Portal();
 
  Portal(asio::io_service &io_service);
 
  void setConsumerCallback(ConsumerCallback *consumer_callback);
 
  void setProducerCallback(ProducerCallback *producer_callback);
 
  void connect(bool is_consumer = true);
 
  ~Portal();
 
  bool interestIsPending(const core::Name &name);
 
  void sendInterest(
      core::Interest::Ptr &&interest,
      OnContentObjectCallback &&on_content_object_callback = UNSET_CALLBACK,
      OnInterestTimeoutCallback &&on_interest_timeout_callback =
          UNSET_CALLBACK);
 
  void bind(const BindConfig &config);
 
  void runEventsLoop();
 
  void runOneEvent();
 
  void sendContentObject(core::ContentObject &content_object);
  void stopEventsLoop();
 
  void killConnection();
 
  void clear();
 
  asio::io_service &getIoService();
 
  void registerRoute(core::Prefix &prefix);
 
 private:
  void *implementation_;
};
 
}  // namespace interface
}  // namespace transport