Global

Members

ASN1HEX

Copyright (C) 2013-2015 Regents of the University of California.
Source:

BinaryXMLDecoder

This class uses BinaryXMLDecoder to follow the structure of a ndnb binary element to determine its end. Copyright (C) 2013-2015 Regents of the University of California.
Source:

BinaryXMLEncoder

This class represents an NDN Data MetaInfo object. Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

This class represents Interest Objects Copyright (C) 2013-2015 Regents of the University of California.
Source:

Blob

Copyright (C) 2013 Regents of the University of California.
Source:

Blob

This class represents an NDN Data Signature object. Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

This class represents an NDN KeyLocator object. Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

This class represents an NDN Data Signature object. Copyright (C) 2014-2015 Regents of the University of California.
Source:

Blob

This class represents a Name as an array of components where each is a byte array. Copyright (C) 2013-2015 Regents of the University of California.
Source:

Blob

Copyright (C) 2013-2015 Regents of the University of California.
Source:

Closure

This is the closure class for use in expressInterest to re express with exponential falloff. Copyright (C) 2013-2015 Regents of the University of California.
Source:

crypto

Copyright (C) 2014-2015 Regents of the University of California.
Source:

crypto

Copyright (C) 2014-2015 Regents of the University of California.
Source:

crypto

Copyright (C) 2014-2015 Regents of the University of California.
Source:

crypto

This class represents the digest tree for chrono-sync2013. Copyright (C) 2014-2015 Regents of the University of California.
Source:

crypto

This class represents the top-level object for communicating with an NDN host. Copyright (C) 2013-2015 Regents of the University of California.
Source:

Crypto

This class represents an NDN Data object. Copyright (C) 2013-2015 Regents of the University of California.
Source:

Crypto

Copyright (C) 2013-2015 Regents of the University of California.
Source:

Data

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Data

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Data

Copyright (C) 2014-2015 Regents of the University of California.
Source:

DataUtils

Copyright (C) 2013-2015 Regents of the University of California.
Source:

DataUtils

This class represents Key Objects Copyright (C) 2013-2015 Regents of the University of California.
Source:

DataUtils

Copyright (C) 2013-2015 Regents of the University of California.
Source:

DataUtils

This file contains utilities to help encode and decode NDN objects. Copyright (C) 2013-2015 Regents of the University of California. author: Meki Cheraoui 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 . A copy of the GNU Lesser General Public License is in the file COPYING.
Source:

DecodingException

Copyright (C) 2014-2015 Regents of the University of California.
Source:

DerNode

Copyright (C) 2014-2015 Regents of the University of California.
Source:

DigestTree

This class represents the digest tree for chrono-sync2013. Copyright (C) 2014-2015 Regents of the University of California.
Source:

dns

Copyright (C) 2013-2015 Regents of the University of California.
Source:

DynamicBuffer

Copyright (C) 2014-2015 Regents of the University of California.
Source:

DynamicBuffer

Copyright (C) 2014-2015 Regents of the University of California.
Source:

ElementReader

Copyright (C) 2014-2015 Regents of the University of California.
Source:

ElementReader

Copyright (C) 2013-2015 Regents of the University of California.
Source:

emptyComponent

< elements are MemoryContentCache.StaleTimeContent
Source:

ForwardingFlags

Copyright (C) 2014-2015 Regents of the University of California.
Source:

ForwardingFlags

This class represents Forwarding Entries Copyright (C) 2013-2015 Regents of the University of California.
Source:

fs

Copyright (C) 2014-2015 Regents of the University of California.
Source:

fs

Copyright (C) 2014-2015 Regents of the University of California.
Source:

IdentityCertificate

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Interest

Copyright (C) 2015 Regents of the University of California.
Source:

Key

Copyright (C) 2013-2015 Regents of the University of California.
Source:

KeyClass

Copyright (C) 2014-2015 Regents of the University of California.
Source:

KeyClassExtensions

File extensions by KeyClass type
Source:

KeyLocatorType

KeyLocator
Source:

KeyType

Copyright (C) 2014-2015 Regents of the University of California.
Source:

LOG

This class represents NDNTime Objects Copyright (C) 2013-2015 Regents of the University of California.
Source:

LOG

This class is used to encode ndnb binary elements (blob, type/value pairs). Copyright (C) 2013-2015 Regents of the University of California.
Source:

MimeTypes

MimeTypes contains a mapping of filename extension to MIME type, and a function getContentTypeAndCharset to select it.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2014-2015 Regents of the University of California.
Source:

Name

Copyright (C) 2015 Regents of the University of California.
Source:

Name

This class represents an Interest Exclude. Copyright (C) 2014-2015 Regents of the University of California.
Source:

ndn

Copyright (C) 2014-2015 Regents of the University of California.
Source:

NDNProtocolDTags

This class contains all NDNx tags Copyright (C) 2013-2015 Regents of the University of California.
Source:

NDNProtocolDTags

This class represents Publisher and PublisherType Objects Copyright (C) 2013-2015 Regents of the University of California.
Source:

NDNProtocolDTags

This class represents PublisherPublicKeyDigest Objects Copyright (C) 2013-2015 Regents of the University of California.
Source:

NDNProtocolDTags

This class is used to decode ndnb binary elements (blob, type/value pairs). Copyright (C) 2013-2015 Regents of the University of California.
Source:

NDNProtocolDTags

This class represents Face Instances Copyright (C) 2013-2015 Regents of the University of California.
Source:

noStaleTimeCache

< elements are number
Source:

registeredPrefixIdList

< The map key is the prefix.toUri(). The value is an OnInterest function.
Source:

staleTimeCache

< elements are MemoryContentCache.Content
Source:

TcpTransport

Copyright (C) 2013-2015 Regents of the University of California.
Source:

TlvDecoder

Copyright (C) 2014-2015 Regents of the University of California.
Source:

TlvEncoder

Copyright (C) 2014-2015 Regents of the University of California.
Source:

WireFormat

Copyright (C) 2014-2015 Regents of the University of California.
Source:

WireFormat

Copyright (C) 2013-2015 Regents of the University of California.
Source:

WireFormat

Copyright (C) 2013-2015 Regents of the University of California.
Source:

Methods

Blob(value, copy)

A Blob holds an immutable byte array implemented as a Buffer. This should be treated like a string which is a pointer to an immutable string. (It is OK to pass a pointer to the string because the new owner can’t change the bytes of the string.) Blob does not inherit from Buffer. Instead you must call buf() to get the byte array which reminds you that you should not change the contents. Also remember that buf() can return null.
Parameters:
Name Type Description
value Blob | Buffer | Array.<number> (optional) If value is a Blob, take another pointer to the Buffer without copying. If value is a Buffer or byte array, copy to create a new Buffer. If omitted, buf() will return null.
copy boolean (optional) (optional) If true, copy the contents of value into a new Buffer. If false, just use the existing value without copying. If omitted, then copy the contents (unless value is already a Blob). IMPORTANT: If copy is false, if you keep a pointer to the value then you must treat the value as immutable and promise not to change it.
Source:

Certificate(data)

Create a Certificate from the content in the data packet (if not omitted).
Parameters:
Name Type Description
data Data (optional) The data packet with the content to decode. If omitted, create a Certificate with default values and the Data content is empty.
Source:

CertificateCache()

A CertificateCache is used to save other users' certificate during verification.
Source:

CertificateExtension(oid, isCritical, value)

A CertificateExtension represents the Extension entry in a certificate. Create a new CertificateExtension.
Parameters:
Name Type Description
oid string | OID The oid of subject description entry.
isCritical boolean If true, the extension must be handled.
value Blob The extension value.
Source:

CertificateSubjectDescription(oid, value)

A CertificateSubjectDescription represents the SubjectDescription entry in a Certificate. Create a new CertificateSubjectDescription.
Parameters:
Name Type Description
oid string | OID The oid of the subject description entry.
value string The value of the subject description entry.
Source:

ChronoSync2013(onReceivedSyncState, onInitialized, applicationDataPrefix, applicationBroadcastPrefix, sessionNo, face, keyChain, certificateName, syncLifetime, onRegisterFailed)

ChronoSync2013 implements the NDN ChronoSync protocol as described in the 2013 paper "Let's ChronoSync: Decentralized Dataset State Synchronization in Named Data Networking". http://named-data.net/publications/chronosync .
Parameters:
Name Type Description
onReceivedSyncState function When ChronoSync receives a sync state message, this calls onReceivedSyncState(syncStates, isRecovery) where syncStates is the list of SyncState messages and isRecovery is true if this is the initial list of SyncState messages or from a recovery interest. (For example, if isRecovery is true, a chat application would not want to re-display all the associated chat messages.) The callback should send interests to fetch the application data for the sequence numbers in the sync state.
onInitialized function This calls onInitialized() when the first sync data is received (or the interest times out because there are no other publishers yet).
applicationDataPrefix Name The prefix used by this application instance for application data. For example, "/my/local/prefix/ndnchat4/0K4wChff2v". This is used when sending a sync message for a new sequence number. In the sync message, this uses applicationDataPrefix.toUri().
applicationBroadcastPrefix Name The broadcast name prefix including the application name. For example, "/ndn/broadcast/ChronoChat-0.3/ndnchat1". This makes a copy of the name.
sessionNo int The session number used with the applicationDataPrefix in sync state messages.
face Face The Face for calling registerPrefix and expressInterest. The Face object must remain valid for the life of this ChronoSync2013 object.
keyChain KeyChain To sign a data packet containing a sync state message, this calls keyChain.sign(data, certificateName).
certificateName Name The certificate name of the key to use for signing a data packet containing a sync state message.
syncLifetime Milliseconds The interest lifetime in milliseconds for sending sync interests.
onRegisterFailed function If failed to register the prefix to receive interests for the applicationBroadcastPrefix, this calls onRegisterFailed(applicationBroadcastPrefix).
Source:

ConfigPolicyManager(configFileName, certificateCache, searchDepth, graceInterval, keyTimestampTtl, maxTrackedKeys)

ConfigPolicyManager manages trust according to a configuration file in the Validator Configuration File Format (http://redmine.named-data.net/projects/ndn-cxx/wiki/CommandValidatorConf) Once a rule is matched, the ConfigPolicyManager looks in the CertificateCache for the IdentityCertificate matching the name in the KeyLocator and uses its public key to verify the data packet or signed interest. If the certificate can't be found, it is downloaded, verified and installed. A chain of certificates will be followed to a maximum depth. If the new certificate is accepted, it is used to complete the verification. The KeyLocators of data packets and signed interests MUST contain a name for verification to succeed. Create a new ConfigPolicyManager which acts on the rules specified in the configuration file and downloads unknown certificates when necessary. Note: This only works in Node.js since it reads files using the "fs" module.
Parameters:
Name Type Description
configFileName string The path to the configuration file containing verification rules.
certificateCache CertificateCache (optional) A CertificateCache to hold known certificates. If this is null or omitted, then create an internal CertificateCache.
searchDepth number (optional) The maximum number of links to follow when verifying a certificate chain. If omitted, use a default.
graceInterval number (optional) The window of time difference (in milliseconds) allowed between the timestamp of the first interest signed with a new public key and the validation time. If omitted, use a default value.
keyTimestampTtl number (optional) How long a public key's last-used timestamp is kept in the store (milliseconds). If omitted, use a default value.
maxTrackedKeys number The maximum number of public key use timestamps to track. If omitted, use a default.
Source:

ContentObject()

Deprecated:
  • Use new Data.
Source:

DerNode(nodeType)

DerNode implements the DER node types used in encoding/decoding DER-formatted data. Create a generic DER node with the given nodeType. This is a private constructor used by one of the public DerNode subclasses defined below.
Parameters:
Name Type Description
nodeType number One of the defined DER DerNodeType constants.
Source:

DerNodeType()

The DerNodeType enum defines the known DER node types.
Source:

DetectSubtleCrypto()

This module checks for the availability of various crypto.subtle api's at runtime, exporting a function that returns the known availability of necessary NDN crypto apis Copyright (C) 2014-2015 Regents of the University of California.
Source:

encodeToBinaryContentObject()

Deprecated:
  • Use data.wireEncode().
Source:

encodeToBinaryInterest()

Deprecated:
  • Use interest.wireEncode().
Source:

ExponentialReExpress()

An ExponentialReExpress is used by onTimeout to express the interest again with double the interestLifetime. See ExponentialReExpress.makeOnTimeout, which you should call instead of the private constructor. Create a new ExponentialReExpressClosure where upcall responds to UPCALL_INTEREST_TIMED_OUT by expressing the interest again with double the interestLifetime. If the interesLifetime goes over maxInterestLifetime, then call callerClosure.upcall with UPCALL_INTEREST_TIMED_OUT. When upcall is not UPCALL_INTEREST_TIMED_OUT, just call callerClosure.upcall.
Source:

ExponentialReExpressClosure()

Deprecated:
  • Use ExponentialReExpress.makeOnTimeout().
Source:

FaceInstance()

Deprecated:
  • This is only used for NDNx support which is deprecated.
Source:

ForwardingFlags()

A ForwardingFlags object holds the flags which specify how the forwarding daemon should forward an interest for a registered prefix. We use a separate ForwardingFlags object to retain future compatibility if the daemon forwarding bits are changed, amended or deprecated. Create a new ForwardingFlags with "active" and "childInherit" set and all other flags cleared.
Source:

KeyName()

Deprecated:
  • Use KeyLocator getKeyName and setKeyName. This is only needed to support NDNx and will be removed.
Source:

Log()

The Log class holds the global static variable LOG.
Source:

MemoryContentCache(face, cleanupIntervalMilliseconds)

A MemoryContentCache holds a set of Data packets and answers an Interest to return the correct Data packet. The cache is periodically cleaned up to remove each stale Data packet based on its FreshnessPeriod (if it has one).
Parameters:
Name Type Description
face Face The Face to use to call registerPrefix and which will call the OnInterest callback.
cleanupIntervalMilliseconds number (optional) The interval in milliseconds between each check to clean up stale content in the cache. If omitted, use a default of 1000 milliseconds. If this is a large number, then effectively the stale content will not be removed from the cache.
Source:

NameEnumeration(face, onComponents)

Create a context for getting the response from the name enumeration command, as needed by getComponents. (To do name enumeration, call the static method NameEnumeration.getComponents.)
Parameters:
Name Type Description
face Face The Face object for using expressInterest.
onComponents function The onComponents callback given to getComponents.
Source:

NDN()

Deprecated:
  • Use new Face.
Source:

NdnRegexMatcher()

An NdnRegexMatcher has static methods to convert an NDN regex (http://redmine.named-data.net/projects/ndn-cxx/wiki/Regex) to a JavaScript RegExp that can match against URIs.
Source:

NDNTime()

Deprecated:
  • This is only used for NDNx support which is deprecated.
Source:

OID()

Copyright (C) 2014-2015 Regents of the University of California.
Source:

ProtobufTlv()

ProtobufTlv has static methods to encode and decode an Protobuf Message o bject as NDN-TLV. The Protobuf tag value is used as the TLV type code. A Protobuf message is encoded/decoded as a nested TLV encoding. Protobuf types uint32, uint64 and enum are encoded/decoded as TLV nonNegativeInteger. (It is an error if an enum value is negative.) Protobuf types bytes and string are encoded/decoded as TLV bytes. The Protobuf type bool is encoded/decoded as a TLV boolean (a zero length value for True, omitted for False). Other Protobuf types are an error. Protobuf has no "outer" message type, so you need to put your TLV message inside an outer "typeless" message.
Source:

PublicKey(keyDer)

Create a new PublicKey by decoding the keyDer. Set the key type from the decoding.
Parameters:
Name Type Description
keyDer Blob The blob of the SubjectPublicKeyInfo DER.
Source:
Throws:
if can't decode the key DER.
Type
UnrecognizedKeyFormatException

PublisherID()

Deprecated:
  • Use KeyLocator getKeyData and setKeyData.
Source:

PublisherPublicKeyDigest()

Deprecated:
  • This is only used for NDNx support which is deprecated.
Source:

Signature()

Note: This Signature class is not the same as the base Signature class of the Common Client Libraries API. It is a deprecated name for Sha256WithRsaSignature. In the future, after we remove this deprecated class, we may implement the CCL version of Signature.
Deprecated:
  • Use new Sha256WithRsaSignature.
Source:

SignedBlob(value, signedPortionBeginOffset, signedPortionEndOffset)

A SignedBlob extends Blob to keep the offsets of a signed portion (e.g., the bytes of Data packet). This inherits from Blob, including Blob.size and Blob.buf.
Parameters:
Name Type Description
value Blob | Buffer | Array.<number> (optional) If value is a Blob, take another pointer to the Buffer without copying. If value is a Buffer or byte array, copy to create a new Buffer. If omitted, buf() will return null.
signedPortionBeginOffset number (optional) The offset in the encoding of the beginning of the signed portion. If omitted, set to 0.
signedPortionEndOffset number (optional) The offset in the encoding of the end of the signed portion. If omitted, set to 0.
Source:

SignedInfo()

Deprecated:
  • Use new MetaInfo.
Source:

TcpTransport()

A TcpTransport connects to the forwarder using TCP for Node.js.
Source:

TlvStructureDecoder()

Create and initialize a TlvStructureDecoder.
Source:

Transport()

Transport is a base class for specific transport classes such as TcpTransport.
Source:

UnixTransport()

A UnixTransport connects to the forwarder using a Unix socket for Node.js.
Source: