dummy-client-face.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 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_CXX_UTIL_DUMMY_CLIENT_FACE_HPP
#define NDN_CXX_UTIL_DUMMY_CLIENT_FACE_HPP
 
#include "ndn-cxx/face.hpp"
#include "ndn-cxx/security/key-chain.hpp"
#include "ndn-cxx/util/signal/signal.hpp"
 
namespace ndn {
 
struct DummyClientFaceOptions
{
  DummyClientFaceOptions() = default;
 
  DummyClientFaceOptions(bool enablePacketLogging, bool enableRegistrationReply,
                         const std::function<void(time::milliseconds)>& processEventsOverride = nullptr)
    : enablePacketLogging(enablePacketLogging)
    , enableRegistrationReply(enableRegistrationReply)
    , processEventsOverride(processEventsOverride)
  {
  }
 
  bool enablePacketLogging = true;
 
  bool enableRegistrationReply = false;
 
  uint64_t registrationReplyFaceId = 1;
 
  std::function<void(time::milliseconds)> processEventsOverride;
};
 
class DummyClientFace : public Face
{
public:
  class AlreadyLinkedError : public Error
  {
  public:
    AlreadyLinkedError();
  };
 
  using Options = DummyClientFaceOptions;
 
  explicit
  DummyClientFace(const Options& options = {});
 
  explicit
  DummyClientFace(KeyChain& keyChain, const Options& options = {});
 
  explicit
  DummyClientFace(boost::asio::io_context& ioCtx, const Options& options = {});
 
  DummyClientFace(boost::asio::io_context& ioCtx, KeyChain& keyChain, const Options& options = {});
 
  ~DummyClientFace() override;
 
  void
  receive(const Interest& interest);
 
  void
  receive(const Data& data);
 
  void
  receive(const lp::Nack& nack);
 
  void
  linkTo(DummyClientFace& other);
 
  void
  unlink();
 
private:
  void
  construct(const Options& options);
 
  void
  enableBroadcastLink();
 
  void
  enablePacketLogging();
 
  void
  enableRegistrationReply(uint64_t faceId);
 
  void
  doProcessEvents(time::milliseconds timeout, bool keepRunning) override;
 
public:
  std::vector<Interest> sentInterests;
 
  std::vector<Data> sentData;
 
  std::vector<lp::Nack> sentNacks;
 
  signal::Signal<DummyClientFace, Interest> onSendInterest;
 
  signal::Signal<DummyClientFace, Data> onSendData;
 
  signal::Signal<DummyClientFace, lp::Nack> onSendNack;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  struct BroadcastLink;
  shared_ptr<BroadcastLink> m_bcastLink;
  std::unique_ptr<KeyChain> m_internalKeyChain;
  KeyChain& m_keyChain;
  std::function<void(time::milliseconds)> m_processEventsOverride;
};
 
} // namespace ndn
 
#endif // NDN_CXX_UTIL_DUMMY_CLIENT_FACE_HPP