net.named_data.jndn

Class ThreadPoolFace

java.lang.Object

net.named_data.jndn.Face

net.named_data.jndn.ThreadPoolFace

public class ThreadPoolFace
extends Face

ThreadPoolFace extends Face to provide the main methods for NDN communication by submitting to a given ScheduledExecutorService thread pool. This also uses the thread pool to schedule the interest timeouts.

Field Summary

Fields inherited from class net.named_data.jndn.Face

node_

Constructor Summary

Constructors

Constructor and Description
ThreadPoolFace(ScheduledExecutorService threadPool, Transport transport, Transport.ConnectionInfo connectionInfo) Create a new ThreadPoolFace for communication with an NDN hub with the given Transport object and connectionInfo.

Method Summary

Methods

Modifier and Type	Method and Description
void	callLater(double delayMilliseconds, Runnable callback) Override to schedule in the thread pool to call callback.run() after the given delay.
long	expressInterest(Interest interest, OnData onData, OnTimeout onTimeout, WireFormat wireFormat) Submit a task to the thread pool to send the Interest through the transport, read the entire response and call onData(interest, data).

Methods inherited from class net.named_data.jndn.Face

expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, expressInterest, getMaxNdnPacketSize, isLocal, makeCommandInterest, makeCommandInterest, processEvents, putData, putData, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, registerPrefix, removePendingInterest, removeRegisteredPrefix, send, send, setCommandCertificateName, setCommandSigningInfo, setInterestFilter, setInterestFilter, shutdown, unsetInterestFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadPoolFace

public ThreadPoolFace(ScheduledExecutorService threadPool,
              Transport transport,
              Transport.ConnectionInfo connectionInfo)

Create a new ThreadPoolFace for communication with an NDN hub with the given Transport object and connectionInfo.

Parameters:

threadPool - The thread pool used to submit method calls such as expressInterest and the related callbacks such as onData. The thread pool is also used to schedule the interest timeouts.

transport - A Transport object used for communication. If you do not want to call processEvents, then the transport should be an async transport like AsyncTcpTransport, in which case the transport should use the same ioService.

connectionInfo - A Transport.ConnectionInfo to be used to connect to the transport.

Method Detail

expressInterest

public long expressInterest(Interest interest,
                   OnData onData,
                   OnTimeout onTimeout,
                   WireFormat wireFormat)
                     throws IOException

Submit a task to the thread pool to send the Interest through the transport, read the entire response and call onData(interest, data).

Overrides:

expressInterest in class Face

Parameters:

interest - The Interest to send. This copies the Interest.

onData - When a matching data packet is received, this calls onData.onData(interest, data) where interest is the interest given to expressInterest and data is the received Data object. NOTE: You must not change the interest object - if you need to change it then make a copy. This wraps the callback to submit it to the thread pool.

onTimeout - If the interest times out according to the interest lifetime, this calls onTimeout.onTimeout(interest) where interest is the interest given to expressInterest. If onTimeout is null, this does not use it. This wraps the callback to submit it to the thread pool.

wireFormat - A WireFormat object used to encode the message.

Returns:

The pending interest ID which can be used with removePendingInterest.

Throws:

IOException - For I/O error in sending the interest.

callLater

public void callLater(double delayMilliseconds,
             Runnable callback)

Override to schedule in the thread pool to call callback.run() after the given delay. Even though this is public, it is not part of the public API of Face.

Overrides:

callLater in class Face

Parameters:

delayMilliseconds - The delay in milliseconds.

callback - This calls callback.run() after the delay.