net.named_data.jndn.Node Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jndn-android-with-async-io Show documentation
Show all versions of jndn-android-with-async-io Show documentation
jNDN is a new implementation of a Named Data Networking client library written in Java. It is wire format compatible with the new NDN-TLV encoding, with NDNx and PARC's CCNx.
/**
* Copyright (C) 2014-2017 Regents of the University of California.
* @author: Jeff Thompson
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see pitEntries =
new ArrayList();
pendingInterestTable_.extractEntriesForNackInterest(interest, pitEntries);
for (int i = 0; i < pitEntries.size(); ++i) {
PendingInterestTable.Entry pendingInterest = pitEntries.get(i);
try {
pendingInterest.getOnNetworkNack().onNetworkNack
(pendingInterest.getInterest(), networkNack);
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onNack", ex);
}
}
// We have processed the network Nack packet.
return;
}
}
// Now process as Interest or Data.
if (interest != null) {
// Quickly lock and get all interest filter callbacks which match.
ArrayList matchedFilters = new ArrayList();
interestFilterTable_.getMatchedFilters(interest, matchedFilters);
// The lock on interestFilterTable_ is released, so call the callbacks.
for (int i = 0; i < matchedFilters.size(); ++i) {
InterestFilterTable.Entry entry =
(InterestFilterTable.Entry)matchedFilters.get(i);
try {
entry.getOnInterest().onInterest
(entry.getFilter().getPrefix(), interest, entry.getFace(),
entry.getInterestFilterId(), entry.getFilter());
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onInterest", ex);
}
}
}
else if (data != null) {
ArrayList pitEntries =
new ArrayList();
pendingInterestTable_.extractEntriesForExpressedInterest(data, pitEntries);
for (int i = 0; i < pitEntries.size(); ++i) {
PendingInterestTable.Entry pendingInterest = pitEntries.get(i);
try {
pendingInterest.getOnData().onData(pendingInterest.getInterest(), data);
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onData", ex);
}
}
}
}
/**
* Check if the face is local based on the current connection through the
* Transport; some Transport may cause network IO (e.g. an IP host name lookup).
* @return True if the face is local, false if not.
* @throws IOException
*/
public final boolean isLocal() throws IOException{
return transport_.isLocal(connectionInfo_);
}
/**
* Shut down by closing the transport
*/
public final void
shutdown()
{
try {
transport_.close();
}
catch (IOException e) {}
}
/**
* Get the practical limit of the size of a network-layer packet. If a packet
* is larger than this, the library or application MAY drop it.
* @return The maximum NDN packet size.
*/
public static int
getMaxNdnPacketSize() { return Common.MAX_NDN_PACKET_SIZE; }
/**
* Call callback.run() after the given delay. This adds to
* delayedCallTable_ which is used by processEvents().
* @param delayMilliseconds The delay in milliseconds.
* @param callback This calls callback.run() after the delay.
*/
public final void
callLater(double delayMilliseconds, Runnable callback)
{
delayedCallTable_.callLater(delayMilliseconds, callback);
}
/**
* Get the next unique entry ID for the pending interest table, interest
* filter table, etc. This uses a synchronized to be thread safe. Most entry
* IDs are for the pending interest table (there usually are not many interest
* filter table entries) so we use a common pool to only have to do the thread
* safe lock in one method which is called by Face.
* @return The next entry ID.
*/
public long
getNextEntryId()
{
synchronized(lastEntryIdLock_) {
return ++lastEntryId_;
}
}
/**
* This is used in callLater for when the pending interest expires. If the
* pendingInterest is still in the pendingInterestTable_, remove it and call
* its onTimeout callback.
* @param pendingInterest The pending interest to check.
*/
private void
processInterestTimeout(PendingInterestTable.Entry pendingInterest)
{
if (pendingInterestTable_.removeEntry(pendingInterest))
pendingInterest.callTimeout();
}
/**
* Do the work of expressInterest once we know we are connected. Add the entry
* to the PIT, encode and send the interest.
* @param pendingInterestId The getNextEntryId() for the pending interest ID
* which Face got so it could return it to the caller.
* @param interestCopy The Interest to send, which has already been copied by
* expressInterest.
* @param onData This calls onData.onData when a matching data packet is
* received.
* @param onTimeout This calls onTimeout.onTimeout if the interest times out.
* If onTimeout is null, this does not use it.
* @param onNetworkNack This calls onNetworkNack.onNetworkNack when a network
* Nack packet is received. If onNetworkNack is null, this does not use it.
* @param wireFormat A WireFormat object used to encode the message.
* @param face The face which has the callLater method, used for interest
* timeouts. The callLater method may be overridden in a subclass of Face.
* @throws IOException For I/O error in sending the interest.
* @throws Error If the encoded interest size exceeds getMaxNdnPacketSize().
*/
private void
expressInterestHelper
(long pendingInterestId, Interest interestCopy, OnData onData,
OnTimeout onTimeout, OnNetworkNack onNetworkNack, WireFormat wireFormat,
Face face) throws IOException
{
final PendingInterestTable.Entry pendingInterest =
pendingInterestTable_.add
(pendingInterestId, interestCopy, onData, onTimeout, onNetworkNack);
if (pendingInterest == null)
// removePendingInterest was already called with the pendingInterestId.
return;
if (onTimeout != null || interestCopy.getInterestLifetimeMilliseconds() >= 0.0) {
// Set up the timeout.
double delayMilliseconds = interestCopy.getInterestLifetimeMilliseconds();
if (delayMilliseconds < 0.0)
// Use a default timeout delay.
delayMilliseconds = 4000.0;
face.callLater
(delayMilliseconds,
new Runnable() {
public void run() { processInterestTimeout(pendingInterest); }
});
}
// Special case: For timeoutPrefix_ we don't actually send the interest.
if (!timeoutPrefix_.match(interestCopy.getName())) {
Blob encoding = interestCopy.wireEncode(wireFormat);
if (encoding.size() > getMaxNdnPacketSize())
throw new Error
("The encoded interest size exceeds the maximum limit getMaxNdnPacketSize()");
transport_.send(encoding.buf());
}
}
private enum ConnectStatus { UNCONNECTED, CONNECT_REQUESTED, CONNECT_COMPLETE }
private static class RegisterResponse implements OnData, OnTimeout {
public RegisterResponse(Info info, Node parent)
{
info_ = info;
parent_ = parent;
}
/**
* We received the response.
* @param interest
* @param responseData
*/
public void
onData(Interest interest, Data responseData)
{
// Decode responseData.getContent() and check for a success code.
ControlResponse controlResponse = new ControlResponse();
try {
controlResponse.wireDecode(responseData.getContent(), TlvWireFormat.get());
} catch (EncodingException ex) {
logger_.log(Level.INFO,
"Register prefix failed: Error decoding the NFD response: {0}", ex);
try {
info_.onRegisterFailed_.onRegisterFailed(info_.prefix_);
} catch (Throwable exception) {
logger_.log(Level.SEVERE, "Error in onRegisterFailed", exception);
}
return;
}
// Status code 200 is "OK".
if (controlResponse.getStatusCode() != 200) {
logger_.log(Level.INFO,
"Register prefix failed: Expected NFD status code 200, got: {0}",
controlResponse.getStatusCode());
try {
info_.onRegisterFailed_.onRegisterFailed(info_.prefix_);
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onRegisterFailed", ex);
}
return;
}
// Success, so we can add to the registered prefix table.
if (info_.registeredPrefixId_ != 0) {
long interestFilterId = 0;
if (info_.onInterest_ != null) {
// registerPrefix was called with the "combined" form that includes the
// callback, so add an InterestFilterEntry.
interestFilterId = parent_.getNextEntryId();
parent_.setInterestFilter
(interestFilterId, new InterestFilter
(info_.prefix_), info_.onInterest_, info_.face_);
}
if (!parent_.registeredPrefixTable_.add
(info_.registeredPrefixId_, info_.prefix_, interestFilterId)) {
// removeRegisteredPrefix was already called with the registeredPrefixId.
if (interestFilterId > 0)
// Remove the related interest filter we just added.
parent_.unsetInterestFilter(interestFilterId);
return;
}
}
logger_.log(Level.INFO,
"Register prefix succeeded with the NFD forwarder for prefix {0}",
info_.prefix_.toUri());
if (info_.onRegisterSuccess_ != null) {
try {
info_.onRegisterSuccess_.onRegisterSuccess
(info_.prefix_, info_.registeredPrefixId_);
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onRegisterSuccess", ex);
}
}
}
/**
* We timed out waiting for the response.
* @param timedOutInterest
*/
public void
onTimeout(Interest timedOutInterest)
{
logger_.log(Level.INFO,
"Timeout for NFD register prefix command.");
try {
info_.onRegisterFailed_.onRegisterFailed(info_.prefix_);
} catch (Throwable ex) {
logger_.log(Level.SEVERE, "Error in onRegisterFailed", ex);
}
}
public static class Info {
/**
*
* @param prefix
* @param onRegisterFailed
* @param onRegisterSuccess
* @param registeredPrefixId The registered prefix ID also returned by
* registerPrefix.
* @param onInterest The callback to add if register succeeds.
* @param face
*/
public Info
(Name prefix,OnRegisterFailed onRegisterFailed,
OnRegisterSuccess onRegisterSuccess, long registeredPrefixId,
OnInterestCallback onInterest, Face face)
{
prefix_ = prefix;
onRegisterFailed_ = onRegisterFailed;
onRegisterSuccess_ = onRegisterSuccess;
registeredPrefixId_ = registeredPrefixId;
onInterest_ = onInterest;
face_ = face;
}
public final Name prefix_;
public final OnRegisterFailed onRegisterFailed_;
public final OnRegisterSuccess onRegisterSuccess_;
public final long registeredPrefixId_;
public final OnInterestCallback onInterest_;
public final Face face_;
}
private final Info info_;
private final Node parent_;
}
/**
* Do the work of registerPrefix to register with NFD.
* @param registeredPrefixId The getNextEntryId() which registerPrefix got so
* it could return it to the caller. If this is 0, then don't add to
* registeredPrefixTable_ (assuming it has already been done).
* @param prefix
* @param onInterest
* @param onRegisterFailed
* @param onRegisterSuccess
* @param flags
* @param commandKeyChain
* @param commandCertificateName
* @param wireFormat
* @param face The face which is passed to the onInterest callback. If
* onInterest is null, this is ignored.
* @throws SecurityException If cannot find the private key for the
* certificateName.
*/
private void
nfdRegisterPrefix
(long registeredPrefixId, Name prefix, OnInterestCallback onInterest,
OnRegisterFailed onRegisterFailed, OnRegisterSuccess onRegisterSuccess,
ForwardingFlags flags, KeyChain commandKeyChain,
Name commandCertificateName, WireFormat wireFormat, Face face)
throws SecurityException
{
if (commandKeyChain == null)
throw new Error
("registerPrefix: The command KeyChain has not been set. You must call setCommandSigningInfo.");
if (commandCertificateName.size() == 0)
throw new Error
("registerPrefix: The command certificate name has not been set. You must call setCommandSigningInfo.");
ControlParameters controlParameters = new ControlParameters();
controlParameters.setName(prefix);
controlParameters.setForwardingFlags(flags);
Interest commandInterest = new Interest();
// Determine whether to use remote prefix registration.
boolean faceIsLocal;
try {
faceIsLocal = isLocal();
} catch (IOException ex) {
logger_.log(Level.INFO,
"Register prefix failed: Error attempting to determine if the face is local: {0}", ex);
try {
onRegisterFailed.onRegisterFailed(prefix);
} catch (Throwable exception) {
logger_.log(Level.SEVERE, "Error in onRegisterFailed", exception);
}
return;
}
if (faceIsLocal) {
commandInterest.setName(new Name("/localhost/nfd/rib/register"));
// The interest is answered by the local host, so set a short timeout.
commandInterest.setInterestLifetimeMilliseconds(2000.0);
}
else {
commandInterest.setName(new Name("/localhop/nfd/rib/register"));
// The host is remote, so set a longer timeout.
commandInterest.setInterestLifetimeMilliseconds(4000.0);
}
// NFD only accepts TlvWireFormat packets.
commandInterest.getName().append(controlParameters.wireEncode(TlvWireFormat.get()));
makeCommandInterest
(commandInterest, commandKeyChain, commandCertificateName,
TlvWireFormat.get());
// Send the registration interest.
RegisterResponse response = new RegisterResponse
(new RegisterResponse.Info
(prefix, onRegisterFailed, onRegisterSuccess, registeredPrefixId,
onInterest, face),
this);
try {
expressInterest
(getNextEntryId(), commandInterest, response, response, null,
wireFormat, face);
}
catch (IOException ex) {
// Can't send the interest. Call onRegisterFailed.
logger_.log(Level.INFO,
"Register prefix failed: Error sending the register prefix interest to the forwarder: {0}", ex);
try {
onRegisterFailed.onRegisterFailed(prefix);
} catch (Throwable exception) {
logger_.log(Level.SEVERE, "Error in onRegisterFailed", exception);
}
}
}
private final Transport transport_;
private final Transport.ConnectionInfo connectionInfo_;
private final PendingInterestTable pendingInterestTable_ =
new PendingInterestTable();
private final InterestFilterTable interestFilterTable_ =
new InterestFilterTable();
private final RegisteredPrefixTable registeredPrefixTable_ =
new RegisteredPrefixTable(interestFilterTable_);
private final DelayedCallTable delayedCallTable_ = new DelayedCallTable();
// Use ArrayList without generics so it works with older Java compilers.
private final List onConnectedCallbacks_ =
Collections.synchronizedList(new ArrayList()); // Runnable
private final CommandInterestGenerator commandInterestGenerator_ =
new CommandInterestGenerator();
private final Name timeoutPrefix_ = new Name("/local/timeout");
private long lastEntryId_;
private final Object lastEntryIdLock_ = new Object();
private ConnectStatus connectStatus_ = ConnectStatus.UNCONNECTED;
private static Blob nonceTemplate_ = new Blob(new byte[] { 0, 0, 0, 0 });
private static final Logger logger_ = Logger.getLogger(Node.class.getName());
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy