partial-producer.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2020,  The University of Memphis
 *
 * This file is part of PSync.
 * See AUTHORS.md for complete list of PSync authors and contributors.
 *
 * PSync 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.
 *
 * PSync 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 a copy of the GNU Lesser General Public License along with
 * PSync, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 **/

#ifndef PSYNC_PARTIAL_PRODUCER_HPP
#define PSYNC_PARTIAL_PRODUCER_HPP

#include "PSync/detail/bloom-filter.hpp"
#include "PSync/producer-base.hpp"

#include <map>

#include <ndn-cxx/face.hpp>
#include <ndn-cxx/security/key-chain.hpp>
#include <ndn-cxx/util/scheduler.hpp>
#include <ndn-cxx/util/time.hpp>

namespace psync {

struct PendingEntryInfo
{
  BloomFilter bf;
  IBLT iblt;
  ndn::scheduler::ScopedEventId expirationEvent;
};

const ndn::time::milliseconds HELLO_REPLY_FRESHNESS = 1_s;

class PartialProducer : public ProducerBase
{
public:
  PartialProducer(size_t expectedNumEntries,
                  ndn::Face& face,
                  const ndn::Name& syncPrefix,
                  const ndn::Name& userPrefix,
                  ndn::time::milliseconds helloReplyFreshness = HELLO_REPLY_FRESHNESS,
                  ndn::time::milliseconds syncReplyFreshness = SYNC_REPLY_FRESHNESS,
                  CompressionScheme ibltCompression = CompressionScheme::NONE);

  void
  publishName(const ndn::Name& prefix, ndn::optional<uint64_t> seq = ndn::nullopt);

private:
  void
  satisfyPendingSyncInterests(const ndn::Name& prefix);

PSYNC_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  void
  onHelloInterest(const ndn::Name& prefix, const ndn::Interest& interest);

  void
  onSyncInterest(const ndn::Name& prefix, const ndn::Interest& interest);

PSYNC_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  std::map<ndn::Name, PendingEntryInfo> m_pendingEntries;
  ndn::ScopedRegisteredPrefixHandle m_registeredPrefix;
  ndn::time::milliseconds m_helloReplyFreshness;
};

} // namespace psync

#endif // PSYNC_PARTIAL_PRODUCER_HPP