full-producer.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  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_FULL_PRODUCER_HPP
#define PSYNC_FULL_PRODUCER_HPP
 
#include "PSync/producer-base.hpp"
 
#include <random>
#include <set>
 
#include <ndn-cxx/util/segment-fetcher.hpp>
 
namespace psync {
 
class FullProducer : public ProducerBase
{
public:
  struct Options
  {
    UpdateCallback onUpdate = [] (const auto&) {};
    uint32_t ibfCount = 80;
    CompressionScheme ibfCompression = CompressionScheme::DEFAULT;
    ndn::time::milliseconds syncInterestLifetime = SYNC_INTEREST_LIFETIME;
    ndn::time::milliseconds syncDataFreshness = SYNC_REPLY_FRESHNESS;
    CompressionScheme contentCompression = CompressionScheme::DEFAULT;
  };
 
  FullProducer(ndn::Face& face,
               ndn::KeyChain& keyChain,
               const ndn::Name& syncPrefix,
               const Options& opts);
 
  [[deprecated]]
  FullProducer(ndn::Face& face,
               ndn::KeyChain& keyChain,
               size_t expectedNumEntries,
               const ndn::Name& syncPrefix,
               const ndn::Name& userPrefix,
               UpdateCallback onUpdateCallBack,
               ndn::time::milliseconds syncInterestLifetime = SYNC_INTEREST_LIFETIME,
               ndn::time::milliseconds syncReplyFreshness = SYNC_REPLY_FRESHNESS,
               CompressionScheme ibltCompression = CompressionScheme::DEFAULT,
               CompressionScheme contentCompression = CompressionScheme::DEFAULT);
 
  ~FullProducer();
 
  void
  publishName(const ndn::Name& prefix, std::optional<uint64_t> seq = std::nullopt);
 
PSYNC_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  void
  sendSyncInterest();
 
  void
  processWaitingInterests();
 
  void
  scheduleProcessWaitingInterests();
 
  void
  onSyncInterest(const ndn::Name& prefixName, const ndn::Interest& interest,
                 bool isTimedProcessing = false);
 
  void
  sendSyncData(const ndn::Name& name, const ndn::Block& block,
               ndn::time::milliseconds syncReplyFreshness);
 
  void
  onSyncData(const ndn::Interest& interest, const ndn::ConstBufferPtr& bufferPtr);
 
private:
  void
  satisfyPendingInterests(const ndn::Name& updatedPrefixWithSeq);
 
  void
  deletePendingInterests(const ndn::Name& interestName);
 
  bool
  isFutureHash(const ndn::Name& prefix, const std::set<uint32_t>& negative);
 
#ifdef PSYNC_WITH_TESTS
public:
  size_t nIbfDecodeFailuresAboveThreshold = 0;
  size_t nIbfDecodeFailuresBelowThreshold = 0;
#endif // PSYNC_WITH_TESTS
 
private:
  struct PendingEntryInfo
  {
    detail::IBLT iblt;
    ndn::scheduler::ScopedEventId expirationEvent;
  };
 
  struct WaitingEntryInfo
  {
    uint16_t numTries = 0;
    ndn::Interest::Nonce nonce;
  };
 
  ndn::time::milliseconds m_syncInterestLifetime;
  UpdateCallback m_onUpdate;
  ndn::scheduler::ScopedEventId m_scheduledSyncInterestId;
  static constexpr int MIN_JITTER = 100;
  static constexpr int MAX_JITTER = 500;
  std::uniform_int_distribution<> m_jitter{MIN_JITTER, MAX_JITTER};
  ndn::time::system_clock::time_point m_lastInterestSentTime;
  ndn::Name m_outstandingInterestName;
  ndn::ScopedRegisteredPrefixHandle m_registeredPrefix;
  std::shared_ptr<ndn::SegmentFetcher> m_fetcher;
  uint64_t m_incomingFace = 0;
  std::map<ndn::Name, WaitingEntryInfo> m_waitingForProcessing;
  bool m_inNoNewDataWaitOutPeriod = false;
  ndn::scheduler::ScopedEventId m_interestDelayTimerId;
 
PSYNC_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  std::map<ndn::Name, PendingEntryInfo> m_pendingEntries;
};
 
} // namespace psync
 
#endif // PSYNC_FULL_PRODUCER_HPP