net.named_data.jndn.sync

Class FullPSync2017

java.lang.Object

net.named_data.jndn.sync.PSyncProducerBase

net.named_data.jndn.sync.FullPSync2017

All Implemented Interfaces:

SegmentFetcher.OnError

public class FullPSync2017
extends PSyncProducerBase
implements SegmentFetcher.OnError

FullPSync2017 implements the full sync logic of PSync to synchronize with other nodes, where all nodes want to sync all the names. The application should call publishName whenever it wants to let consumers know that a new name is available. Currently, fetching and publishing the data given by the announced name needs to be handled by the application. The Full PSync protocol is described in Section G "Full-Data Synchronization" of: https://named-data.net/wp-content/uploads/2017/05/scalable_name-based_data_synchronization.pdf (Note: In the PSync library, this class is called FullProducerArbitrary. But because the class actually handles both producing and consuming, we omit "producer" in the name to avoid confusion.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FullPSync2017.CanAddReceivedName
static interface	FullPSync2017.CanAddToSyncData
static interface	FullPSync2017.OnNamesUpdate
class	FullPSync2017.PendingEntryInfoFull

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_SYNC_INTEREST_LIFETIME
static double	DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD

Fields inherited from class net.named_data.jndn.sync.PSyncProducerBase

expectedNEntries_, hashToName_, iblt_, nameToHash_, syncPrefix_, syncReplyFreshnessPeriod_, threshold_

Constructor Summary

Constructors

Constructor and Description
FullPSync2017(int expectedNEntries, Face face, Name syncPrefix, FullPSync2017.OnNamesUpdate onNamesUpdate, KeyChain keyChain) Create a FullPSync2017, where syncInterestLifetime is DEFAULT_SYNC_INTEREST_LIFETIME, syncReplyFreshnessPeriod is DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD and signingInfo is the default SigningInfo().
FullPSync2017(int expectedNEntries, Face face, Name syncPrefix, FullPSync2017.OnNamesUpdate onNamesUpdate, KeyChain keyChain, double syncInterestLifetime, double syncReplyFreshnessPeriod) Create a FullPSync2017, where signingInfo is the default SigningInfo().
FullPSync2017(int expectedNEntries, Face face, Name syncPrefix, FullPSync2017.OnNamesUpdate onNamesUpdate, KeyChain keyChain, double syncInterestLifetime, double syncReplyFreshnessPeriod, SigningInfo signingInfo) Create a FullPSync2017.
FullPSync2017(int expectedNEntries, Face face, Name syncPrefix, FullPSync2017.OnNamesUpdate onNamesUpdate, KeyChain keyChain, double syncInterestLifetime, double syncReplyFreshnessPeriod, SigningInfo signingInfo, FullPSync2017.CanAddToSyncData canAddToSyncData, FullPSync2017.CanAddReceivedName canAddReceivedName) Create a FullPSync2017.

Method Summary

Modifier and Type	Method and Description
void	onError(SegmentFetcher.ErrorCode errorCode, String message)
void	publishName(Name name) Publish the Name to inform the others.

Methods inherited from class net.named_data.jndn.sync.PSyncProducerBase

insertIntoIblt, onRegisterFailed, removeFromIblt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SYNC_INTEREST_LIFETIME

public static final double DEFAULT_SYNC_INTEREST_LIFETIME

See Also:

Constant Field Values

DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD

public static final double DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD

See Also:

Constant Field Values

Constructor Detail

FullPSync2017

public FullPSync2017(int expectedNEntries,
                     Face face,
                     Name syncPrefix,
                     FullPSync2017.OnNamesUpdate onNamesUpdate,
                     KeyChain keyChain,
                     double syncInterestLifetime,
                     double syncReplyFreshnessPeriod,
                     SigningInfo signingInfo,
                     FullPSync2017.CanAddToSyncData canAddToSyncData,
                     FullPSync2017.CanAddReceivedName canAddReceivedName)
              throws IOException,
                     SecurityException

Create a FullPSync2017.

Parameters:

expectedNEntries - The expected number of entries in the IBLT.

face - The application's Face.

syncPrefix - The prefix Name of the sync group, which is copied.

onNamesUpdate - When there are new names, this calls onNamesUpdate.onNamesUpdate(names) where names is a list of Names. However, see the canAddReceivedName callback which can control which names are added. NOTE: The library will log any exceptions thrown by this callback, but for better error handling the callback should catch and properly handle any exceptions.

keyChain - The KeyChain for signing Data packets.

syncInterestLifetime - The Interest lifetime for the sync Interests, in milliseconds.

syncReplyFreshnessPeriod - The freshness period of the sync Data packet, in milliseconds.

signingInfo - The SigningInfo for signing Data packets, which is copied.

canAddToSyncData - When a new IBLT is received in a sync Interest, this calls canAddToSyncData.canAddToSyncData(name, negative) where Name is the candidate Name to add to the response Data packet of Names, and negative is the set of names that the other's user's Name set, but not in our own Name set. If the callback returns false, then this does not report the Name to the other user. However, if canAddToSyncData is null, then each name is reported.

canAddReceivedName - When new names are received, this calls canAddReceivedName.canAddReceivedName(name) for each name. If the callback returns false, then this does not add to the IBLT or report to the application with onNamesUpdate. However, if canAddReceivedName is null, then each name is added.

Throws:

IOException

SecurityException

FullPSync2017

public FullPSync2017(int expectedNEntries,
                     Face face,
                     Name syncPrefix,
                     FullPSync2017.OnNamesUpdate onNamesUpdate,
                     KeyChain keyChain,
                     double syncInterestLifetime,
                     double syncReplyFreshnessPeriod,
                     SigningInfo signingInfo)
              throws IOException,
                     SecurityException

Create a FullPSync2017.

Parameters:

expectedNEntries - The expected number of entries in the IBLT.

face - The application's Face.

syncPrefix - The prefix Name of the sync group, which is copied.

onNamesUpdate - When there are new names, this calls onNamesUpdate.onNamesUpdate(names) where names is a list of Names. However, see the canAddReceivedName callback which can control which names are added. NOTE: The library will log any exceptions thrown by this callback, but for better error handling the callback should catch and properly handle any exceptions.

keyChain - The KeyChain for signing Data packets.

syncInterestLifetime - The Interest lifetime for the sync Interests, in milliseconds.

syncReplyFreshnessPeriod - The freshness period of the sync Data packet, in milliseconds.

signingInfo - The SigningInfo for signing Data packets, which is copied.

Throws:

IOException

SecurityException

FullPSync2017

public FullPSync2017(int expectedNEntries,
                     Face face,
                     Name syncPrefix,
                     FullPSync2017.OnNamesUpdate onNamesUpdate,
                     KeyChain keyChain,
                     double syncInterestLifetime,
                     double syncReplyFreshnessPeriod)
              throws IOException,
                     SecurityException

Create a FullPSync2017, where signingInfo is the default SigningInfo().

Parameters:

expectedNEntries - The expected number of entries in the IBLT.

face - The application's Face.

syncPrefix - The prefix Name of the sync group, which is copied.

onNamesUpdate - When there are new names, this calls onNamesUpdate.onNamesUpdate(names) where names is a list of Names. However, see the canAddReceivedName callback which can control which names are added. NOTE: The library will log any exceptions thrown by this callback, but for better error handling the callback should catch and properly handle any exceptions.

keyChain - The KeyChain for signing Data packets.

syncInterestLifetime - The Interest lifetime for the sync Interests, in milliseconds.

syncReplyFreshnessPeriod - The freshness period of the sync Data packet, in milliseconds.

Throws:

IOException

SecurityException

FullPSync2017

public FullPSync2017(int expectedNEntries,
                     Face face,
                     Name syncPrefix,
                     FullPSync2017.OnNamesUpdate onNamesUpdate,
                     KeyChain keyChain)
              throws IOException,
                     SecurityException

Create a FullPSync2017, where syncInterestLifetime is DEFAULT_SYNC_INTEREST_LIFETIME, syncReplyFreshnessPeriod is DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD and signingInfo is the default SigningInfo().

Parameters:

expectedNEntries - The expected number of entries in the IBLT.

face - The application's Face.

syncPrefix - The prefix Name of the sync group, which is copied.

onNamesUpdate - When there are new names, this calls onNamesUpdate.onNamesUpdate(names) where names is a list of Names. However, see the canAddReceivedName callback which can control which names are added. NOTE: The library will log any exceptions thrown by this callback, but for better error handling the callback should catch and properly handle any exceptions.

keyChain - The KeyChain for signing Data packets.

Throws:

IOException

SecurityException

Method Detail

publishName

public final void publishName(Name name)

Publish the Name to inform the others. However, if the Name has already been published, do nothing.

Parameters:

name - The Name to publish.

onError

public final void onError(SegmentFetcher.ErrorCode errorCode,
                          String message)

Specified by:

onError in interface SegmentFetcher.OnError