net.named_data.jndn.impl

Class PendingInterestTable

java.lang.Object

net.named_data.jndn.impl.PendingInterestTable

public class PendingInterestTable
extends Object

A PendingInterestTable is an internal class to hold a list of pending interests with their callbacks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PendingInterestTable.Entry Entry holds the callbacks and other fields for an entry in the pending interest table.

Constructor Summary

Constructors

Constructor and Description
PendingInterestTable()

Method Summary

Methods

Modifier and Type	Method and Description
PendingInterestTable.Entry	add(long pendingInterestId, Interest interestCopy, OnData onData, OnTimeout onTimeout, OnNetworkNack onNetworkNack) Add a new entry to the pending interest table.
void	extractEntriesForExpressedInterest(Name name, ArrayList<PendingInterestTable.Entry> entries) Find all entries from the pending interest table where the name conforms to the entry's interest selectors, remove the entries from the table, set each entry's isRemoved flag, and add to the entries list.
void	extractEntriesForNackInterest(Interest interest, ArrayList<PendingInterestTable.Entry> entries) Find all entries from the pending interest table where the OnNetworkNack callback is not null and the entry's interest is the same as the given interest, remove the entries from the table, set each entry's isRemoved flag, and add to the entries list.
boolean	removeEntry(PendingInterestTable.Entry pendingInterest) Remove the specific pendingInterest entry from the table and set its isRemoved flag.
void	removePendingInterest(long pendingInterestId) Remove the pending interest entry with the pendingInterestId from the pending interest table and set its isRemoved flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

PendingInterestTable

public PendingInterestTable()

Method Detail

add

public final PendingInterestTable.Entry add(long pendingInterestId,
                             Interest interestCopy,
                             OnData onData,
                             OnTimeout onTimeout,
                             OnNetworkNack onNetworkNack)

Add a new entry to the pending interest table. However, if removePendingInterest was already called with the pendingInterestId, don't add an entry and return null.

Parameters:

pendingInterestId - The getNextEntryId() for the pending interest ID which Face got so it could return it to the caller.

interestCopy - The Interest which was sent, which has already been copied by expressInterest.

onData - Call onData.onData when a matching data packet is received.

onTimeout - This calls onTimeout.onTimeout if the interest times out. If onTimeout is null, this does not use it.

onNetworkNack - Call onNetworkNack.onNetworkNack when a network Nack packet is received.

Returns:

The new PendingInterestTable.Entry, or null if removePendingInterest was already called with the pendingInterestId.

extractEntriesForExpressedInterest

public final void extractEntriesForExpressedInterest(Name name,
                                      ArrayList<PendingInterestTable.Entry> entries)

Find all entries from the pending interest table where the name conforms to the entry's interest selectors, remove the entries from the table, set each entry's isRemoved flag, and add to the entries list.

Parameters:

name - The name to find the interest for (from the incoming data packet).

entries - Add matching PendingInterestTable.Entry from the pending interest table. The caller should pass in an empty ArrayList.

extractEntriesForNackInterest

public final void extractEntriesForNackInterest(Interest interest,
                                 ArrayList<PendingInterestTable.Entry> entries)

Find all entries from the pending interest table where the OnNetworkNack callback is not null and the entry's interest is the same as the given interest, remove the entries from the table, set each entry's isRemoved flag, and add to the entries list. (We don't remove the entry if the OnNetworkNack callback is null so that OnTimeout will be called later.) The interests are the same if their default wire encoding is the same (which has everything including the name, nonce, link object and selectors).

Parameters:

interest - The Interest to search for (typically from a Nack packet).

entries - Add matching PendingInterestTable.Entry from the pending interest table. The caller should pass in an empty ArrayList.

removePendingInterest

public final void removePendingInterest(long pendingInterestId)

Remove the pending interest entry with the pendingInterestId from the pending interest table and set its isRemoved flag. This does not affect another pending interest with a different pendingInterestId, even if it has the same interest name. If there is no entry with the pendingInterestId, do nothing.

Parameters:

pendingInterestId - The ID returned from expressInterest.

removeEntry

public final boolean removeEntry(PendingInterestTable.Entry pendingInterest)

Remove the specific pendingInterest entry from the table and set its isRemoved flag. However, if the pendingInterest isRemoved flag is already true or the entry is not in the pending interest table then do nothing.

Parameters:

pendingInterest - The Entry from the pending interest table.

Returns:

True if the entry was removed, false if not.