net.named_data.jndn.sync.detail

Class PSyncUserPrefixes

java.lang.Object

net.named_data.jndn.sync.detail.PSyncUserPrefixes

public class PSyncUserPrefixes
extends Object

PSyncUserPrefixes holds the prefixes_ map from prefix to sequence number, used by PSyncPartialProducer and FullPSync2017WithUsers.

Field Summary

Fields

Modifier and Type	Field and Description
HashMap<Name,Object>	prefixes_

Constructor Summary

Constructors

Constructor and Description
PSyncUserPrefixes()

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.
int	getSequenceNo(Name prefix) Return the current sequence number of the given prefix.
int	getSequenceNoOrZero(Name prefix) Return the current sequence number of the given prefix, or zero if not found.
boolean	isUserNode(Name prefix) Check if the prefix is in prefixes_.
void	removeUserNode(Name prefix) Remove the user node from synchronization.
boolean	updateSequenceNo(Name prefix, int sequenceNo, int[] oldSequenceNo) Update prefixes_ with the given prefix and sequence number.

Methods inherited from class java.lang.Object

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

Field Detail

prefixes_

public final HashMap<Name,Object> prefixes_

Constructor Detail

PSyncUserPrefixes

public PSyncUserPrefixes()

Method Detail

isUserNode

public final boolean isUserNode(Name prefix)

Check if the prefix is in prefixes_.

Parameters:

prefix - The prefix to check.

Returns:

True if the prefix is in prefixes_.

getSequenceNo

public final int getSequenceNo(Name prefix)

Return the current sequence number of the given prefix.

Parameters:

prefix - The prefix for the sequence number.

Returns:

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

getSequenceNoOrZero

public final int getSequenceNoOrZero(Name prefix)

Return the current sequence number of the given prefix, or zero if not found.

Parameters:

prefix - The prefix for the sequence number.

Returns:

The sequence number for the prefix, or 0 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 synchronization. If the prefix is not in prefixes_, then do nothing. The caller should first check isUserNode(prefix) and erase the prefix from the IBLT and other maps if needed.

Parameters:

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

updateSequenceNo

public final boolean updateSequenceNo(Name prefix,
                                      int sequenceNo,
                                      int[] oldSequenceNo)

Update prefixes_ with the given prefix and sequence number. This does not update the IBLT. This logs a message for the update. Whoever calls this needs to make sure that isUserNode(prefix) is true.

Parameters:

prefix - The prefix of the update.

sequenceNo - The sequence number of the update.

oldSequenceNo - This sets oldSequenceNo[0] to the old sequence number for the prefix. If this method returns true and oldSequenceNo[0] is not zero, the caller can remove the old prefix from the IBLT.

Returns:

True if the sequence number was updated, false if the prefix was not in prefixes_, or if the sequenceNo is less than or equal to the old sequence number. If this returns false, the caller should not update the IBLT.