face.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2019 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#ifndef NDN_FACE_HPP
#define NDN_FACE_HPP

#include "ndn-cxx/data.hpp"
#include "ndn-cxx/interest.hpp"
#include "ndn-cxx/interest-filter.hpp"
#include "ndn-cxx/detail/asio-fwd.hpp"
#include "ndn-cxx/detail/cancel-handle.hpp"
#include "ndn-cxx/encoding/nfd-constants.hpp"
#include "ndn-cxx/lp/nack.hpp"
#include "ndn-cxx/security/key-chain.hpp"
#include "ndn-cxx/security/signing-info.hpp"

namespace ndn {

class Transport;

class PendingInterestId;
class PendingInterestHandle;
class RegisteredPrefixId;
class RegisteredPrefixHandle;
class InterestFilterId;
class InterestFilterHandle;

namespace nfd {
class Controller;
} // namespace nfd

typedef function<void(const Interest&, const Data&)> DataCallback;

typedef function<void(const Interest&, const lp::Nack&)> NackCallback;

typedef function<void(const Interest&)> TimeoutCallback;

typedef function<void(const InterestFilter&, const Interest&)> InterestCallback;

typedef function<void(const Name&)> RegisterPrefixSuccessCallback;

typedef function<void(const Name&, const std::string&)> RegisterPrefixFailureCallback;

typedef function<void()> UnregisterPrefixSuccessCallback;

typedef function<void(const std::string&)> UnregisterPrefixFailureCallback;

class Face : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };

  class OversizedPacketError : public Error
  {
  public:
    OversizedPacketError(char pktType, const Name& name, size_t wireSize);

  public:
    const char pktType;
    const Name name;
    const size_t wireSize;
  };

public: // constructors
  explicit
  Face(shared_ptr<Transport> transport = nullptr);

  explicit
  Face(boost::asio::io_service& ioService);

  explicit
  Face(const std::string& host, const std::string& port = "6363");

  Face(shared_ptr<Transport> transport, KeyChain& keyChain);

  Face(shared_ptr<Transport> transport, boost::asio::io_service& ioService);

  Face(shared_ptr<Transport> transport, boost::asio::io_service& ioService, KeyChain& keyChain);

  virtual
  ~Face();

public: // consumer
  PendingInterestHandle
  expressInterest(const Interest& interest,
                  const DataCallback& afterSatisfied,
                  const NackCallback& afterNacked,
                  const TimeoutCallback& afterTimeout);

  [[deprecated]]
  void
  removePendingInterest(const PendingInterestId* pendingInterestId)
  {
    cancelPendingInterest(pendingInterestId);
  }

  void
  removeAllPendingInterests();

  size_t
  getNPendingInterests() const;

public: // producer
  RegisteredPrefixHandle
  setInterestFilter(const InterestFilter& filter, const InterestCallback& onInterest,
                    const RegisterPrefixFailureCallback& onFailure,
                    const security::SigningInfo& signingInfo = security::SigningInfo(),
                    uint64_t flags = nfd::ROUTE_FLAG_CHILD_INHERIT);

  RegisteredPrefixHandle
  setInterestFilter(const InterestFilter& filter, const InterestCallback& onInterest,
                    const RegisterPrefixSuccessCallback& onSuccess,
                    const RegisterPrefixFailureCallback& onFailure,
                    const security::SigningInfo& signingInfo = security::SigningInfo(),
                    uint64_t flags = nfd::ROUTE_FLAG_CHILD_INHERIT);

  InterestFilterHandle
  setInterestFilter(const InterestFilter& filter, const InterestCallback& onInterest);

  RegisteredPrefixHandle
  registerPrefix(const Name& prefix,
                 const RegisterPrefixSuccessCallback& onSuccess,
                 const RegisterPrefixFailureCallback& onFailure,
                 const security::SigningInfo& signingInfo = security::SigningInfo(),
                 uint64_t flags = nfd::ROUTE_FLAG_CHILD_INHERIT);

  [[deprecated]]
  void
  unsetInterestFilter(const RegisteredPrefixId* registeredPrefixId)
  {
    unregisterPrefixImpl(registeredPrefixId, nullptr, nullptr);
  }

  [[deprecated]]
  void
  unsetInterestFilter(const InterestFilterId* interestFilterId)
  {
    clearInterestFilter(interestFilterId);
  }

  [[deprecated]]
  void
  unregisterPrefix(const RegisteredPrefixId* registeredPrefixId,
                   const UnregisterPrefixSuccessCallback& onSuccess,
                   const UnregisterPrefixFailureCallback& onFailure)
  {
    unregisterPrefixImpl(registeredPrefixId, onSuccess, onFailure);
  }

  void
  put(Data data);

  void
  put(lp::Nack nack);

public: // IO routine
  void
  processEvents(time::milliseconds timeout = time::milliseconds::zero(),
                bool keepThread = false)
  {
    this->doProcessEvents(timeout, keepThread);
  }

  void
  shutdown();

  boost::asio::io_service&
  getIoService()
  {
    return m_ioService;
  }

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED:
  shared_ptr<Transport>
  getTransport();

protected:
  virtual void
  doProcessEvents(time::milliseconds timeout, bool keepThread);

private:
  shared_ptr<Transport>
  makeDefaultTransport();

  void
  construct(shared_ptr<Transport> transport, KeyChain& keyChain);

  void
  onReceiveElement(const Block& blockFromDaemon);

  void
  cancelPendingInterest(const PendingInterestId* pendingInterestId);

  void
  clearInterestFilter(const InterestFilterId* interestFilterId);

  void
  unregisterPrefixImpl(const RegisteredPrefixId* registeredPrefixId,
                       const UnregisterPrefixSuccessCallback& onSuccess,
                       const UnregisterPrefixFailureCallback& onFailure);

private:
  unique_ptr<boost::asio::io_service> m_internalIoService;
  boost::asio::io_service& m_ioService;

  shared_ptr<Transport> m_transport;

  unique_ptr<KeyChain> m_internalKeyChain;

  unique_ptr<nfd::Controller> m_nfdController;

  class Impl;
  shared_ptr<Impl> m_impl;

  friend PendingInterestHandle;
  friend RegisteredPrefixHandle;
  friend InterestFilterHandle;
};

class PendingInterestHandle : public detail::CancelHandle
{
public:
  PendingInterestHandle() noexcept = default;

  PendingInterestHandle(Face& face, const PendingInterestId* id);

  [[deprecated]]
  operator const PendingInterestId*() const noexcept
  {
    return m_id;
  }

private:
  const PendingInterestId* m_id = nullptr;
};

using ScopedPendingInterestHandle = detail::ScopedCancelHandle;

class RegisteredPrefixHandle : public detail::CancelHandle
{
public:
  RegisteredPrefixHandle() noexcept
  {
    // This could have been '= default', but there's compiler bug in Apple clang 9.0.0,
    // see https://stackoverflow.com/a/44693603
  }

  RegisteredPrefixHandle(Face& face, const RegisteredPrefixId* id);

  [[deprecated]]
  operator const RegisteredPrefixId*() const noexcept
  {
    return m_id;
  }

  void
  unregister(const UnregisterPrefixSuccessCallback& onSuccess = nullptr,
             const UnregisterPrefixFailureCallback& onFailure = nullptr);

private:
  Face* m_face = nullptr;
  const RegisteredPrefixId* m_id = nullptr;
};

using ScopedRegisteredPrefixHandle = detail::ScopedCancelHandle;

class InterestFilterHandle : public detail::CancelHandle
{
public:
  InterestFilterHandle() noexcept = default;

  InterestFilterHandle(Face& face, const InterestFilterId* id);

  [[deprecated]]
  operator const InterestFilterId*() const noexcept
  {
    return m_id;
  }

private:
  const InterestFilterId* m_id = nullptr;
};

using ScopedInterestFilterHandle = detail::ScopedCancelHandle;

} // namespace ndn

#endif // NDN_FACE_HPP