net.named_data.jndn.sync

Class FullPSync2017WithUsers

java.lang.Object

net.named_data.jndn.sync.FullPSync2017WithUsers

All Implemented Interfaces:

FullPSync2017.CanAddReceivedName, FullPSync2017.CanAddToSyncData, FullPSync2017.OnNamesUpdate

public class FullPSync2017WithUsers
extends Object
implements FullPSync2017.OnNamesUpdate, FullPSync2017.CanAddToSyncData, FullPSync2017.CanAddReceivedName

FullPSync2017WithUsers uses FullPSync2017 to implement the full sync logic of PSync to synchronize with other nodes, where all nodes want to sync the sequence number of all users based on their user prefix. The application should call publishName whenever it wants to let consumers know that new data with a new sequence number is available for the user prefix. Multiple user prefixes can be added by using addUserNode. Currently, fetching and publishing the data (named by the user prefix plus the sequence number) needs to be handled by the application. See FullPSync2017 for details on the Full PSync protocol. 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 FullProducer. 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	FullPSync2017WithUsers.OnUpdate

Constructor Summary

Constructors

Constructor and Description
FullPSync2017WithUsers(int expectedNEntries, Face face, Name syncPrefix, Name userPrefix, FullPSync2017WithUsers.OnUpdate onUpdate, KeyChain keyChain) Create a FullPSync2017WithUsers, where syncInterestLifetime is FullPSync2017.DEFAULT_SYNC_INTEREST_LIFETIME, syncReplyFreshnessPeriod is FullPSync2017.DEFAULT_SYNC_REPLY_FRESHNESS_PERIOD, and signingInfo is the default SigningInfo().
FullPSync2017WithUsers(int expectedNEntries, Face face, Name syncPrefix, Name userPrefix, FullPSync2017WithUsers.OnUpdate onUpdate, KeyChain keyChain, double syncInterestLifetime, double syncReplyFreshnessPeriod) Create a FullPSync2017WithUsers, where signingInfo is the default SigningInfo().
FullPSync2017WithUsers(int expectedNEntries, Face face, Name syncPrefix, Name userPrefix, FullPSync2017WithUsers.OnUpdate onUpdate, KeyChain keyChain, double syncInterestLifetime, double syncReplyFreshnessPeriod, SigningInfo signingInfo) Create a FullPSync2017WithUsers.

Method Summary

Modifier and Type	Method and Description
boolean	addUserNode(Name prefix) Add a user node for synchronization based on the prefix Name, and initialize the sequence number to zero.
boolean	canAddReceivedName(Name name) This is called when new names are received to check if the name can be added to the IBLT.
boolean	canAddToSyncData(Name name, HashSet<Long> negative) Get the prefix from the name and check if hash(prefix + 1) is in the negative set, i.e.
int	getSequenceNo(Name prefix) Return the current sequence number of the given user prefix.
void	onNamesUpdate(ArrayList<Name> names) This is called when new names are received.
void	publishName(Name prefix) Publish the sequence number for the prefix Name to inform the others, where the existing sequence number is incremented by 1.
void	publishName(Name prefix, int sequenceNo) Publish the sequence number for the prefix Name to inform the others.
void	removeUserNode(Name prefix) Remove the user node from the synchronization.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullPSync2017WithUsers

public FullPSync2017WithUsers(int expectedNEntries,
                              Face face,
                              Name syncPrefix,
                              Name userPrefix,
                              FullPSync2017WithUsers.OnUpdate onUpdate,
                              KeyChain keyChain,
                              double syncInterestLifetime,
                              double syncReplyFreshnessPeriod,
                              SigningInfo signingInfo)
                       throws IOException,
                              SecurityException

Create a FullPSync2017WithUsers.

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.

userPrefix - The prefix Name of the first user in the group, which is copied. However, if this Name is empty, it is not added and you must call addUserNode.

onUpdate - When there is new data, this calls onUdate.onUdate(updates) where updates is a list of PSyncMissingDataInfo. 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

FullPSync2017WithUsers

public FullPSync2017WithUsers(int expectedNEntries,
                              Face face,
                              Name syncPrefix,
                              Name userPrefix,
                              FullPSync2017WithUsers.OnUpdate onUpdate,
                              KeyChain keyChain,
                              double syncInterestLifetime,
                              double syncReplyFreshnessPeriod)
                       throws IOException,
                              SecurityException

Create a FullPSync2017WithUsers, 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.

userPrefix - The prefix Name of the first user in the group, which is copied. However, if this Name is empty, it is not added and you must call addUserNode.

onUpdate - When there is new data, this calls onUdate.onUdate(updates) where updates is a list of PSyncMissingDataInfo. 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

FullPSync2017WithUsers

public FullPSync2017WithUsers(int expectedNEntries,
                              Face face,
                              Name syncPrefix,
                              Name userPrefix,
                              FullPSync2017WithUsers.OnUpdate onUpdate,
                              KeyChain keyChain)
                       throws IOException,
                              SecurityException

Create a FullPSync2017WithUsers, where syncInterestLifetime is FullPSync2017.DEFAULT_SYNC_INTEREST_LIFETIME, syncReplyFreshnessPeriod is FullPSync2017.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.

userPrefix - The prefix Name of the first user in the group, which is copied. However, if this Name is empty, it is not added and you must call addUserNode.

onUpdate - When there is new data, this calls onUdate.onUdate(updates) where updates is a list of PSyncMissingDataInfo. 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

getSequenceNo

public final int getSequenceNo(Name prefix)

Return the current sequence number of the given user prefix.

Parameters:

prefix - The user prefix for the sequence number.

Returns:

The sequence number for the user prefix, or -1 if not found.

addUserNode

public final boolean addUserNode(Name prefix)

Add a user node for synchronization based on the prefix Name, and initialize the sequence number to zero. However, if the prefix Name already exists, then do nothing and return false. This does not add sequence number zero to the IBLT because, if a large number of user nodes are added, then decoding the difference between our own IBLT and the other IBLT will not be possible.

Parameters:

prefix - The prefix Name of the user node to be added.

Returns:

True if the user node with the prefix Name was added, false if the prefix Name already exists.

removeUserNode

public final void removeUserNode(Name prefix)

Remove the user node from the synchronization. This erases the prefix from the IBLT and other tables.

Parameters:

prefix - The prefix Name of the user node to be removed. If there is no user node with this prefix, do nothing.

publishName

public final void publishName(Name prefix,
                              int sequenceNo)

Publish the sequence number for the prefix Name to inform the others. (addUserNode needs to be called before this to add the prefix, if it was not already added via the constructor.)

Parameters:

prefix - the prefix Name to be updated.

sequenceNo - The sequence number of the user prefix to be set in the IBLT. However, if sequenceNo is -1, then the existing sequence number is incremented by 1.

publishName

public final void publishName(Name prefix)

Publish the sequence number for the prefix Name to inform the others, where the existing sequence number is incremented by 1. (addUserNode needs to be called before this to add the prefix, if it was not already added via the constructor.)

Parameters:

prefix - the prefix Name to be updated.

canAddReceivedName

public final boolean canAddReceivedName(Name name)

This is called when new names are received to check if the name can be added to the IBLT.

Specified by:

canAddReceivedName in interface FullPSync2017.CanAddReceivedName

Parameters:

name - The Name to check.

Returns:

True if the received name can be added.

onNamesUpdate

public final void onNamesUpdate(ArrayList<Name> names)

This is called when new names are received. Update prefixes_, create the list of PSyncMissingDataInfo and call the onUpdate_ callback.

Specified by:

onNamesUpdate in interface FullPSync2017.OnNamesUpdate

Parameters:

names - The new received names.

canAddToSyncData

public final boolean canAddToSyncData(Name name,
                                      HashSet<Long> negative)

Get the prefix from the name and check if hash(prefix + 1) is in the negative set, i.e. "isNotFutureHash" (Sometimes the Interest from the other side gets to us before the Data.)

Specified by:

canAddToSyncData in interface FullPSync2017.CanAddToSyncData

Returns:

True if hash(prefix + 1) is NOT in the negative set (meaning that it is not a future hash), or false if it IS in the negative set.