NDN Common Client Libraries API

This documents the API for the NDN client libraries, showing the classes and method declarations for C++, Python, JavaScript and Java.

Table of Contents:

• Name Class
  • Name Constructors
    • Name Constructor (array of components)
    • Name Constructor (from URI)
    • Name Constructor (copy)
  • Name.append Methods
    • Name.append Method (copy byte array)
    • Name.append Method (from Unicode string)
    • Name.append Method (from Blob)
    • Name.append Method (from Component)
    • Name.append Method (from Name)
  • Name.appendImplicitSha256Digest Method
  • Name.appendParametersSha256Digest Method
  • Name.appendSegment Method
  • Name.appendSegmentOffset Method
  • Name.appendSequenceNumber Method
  • Name.appendTimestamp Method
  • Name.appendVersion Method
  • Name.clear Method
  • Name.compare Methods
    • Name.compare Method (basic)
    • Name.compare Method (sub names)
  • Name.equals Method
  • Name.fromEscapedString Method
  • Name.get Method
  • Name.getPrefix Method
  • Name.getSubName Method
  • Name.Component.getSuccessor Method
  • Name.match Method
  • Name.set Method
  • Name.size Method
  • Name.toUri Method
  • Name.wireDecode Methods
    • Name.wireDecode Method (from Blob)
    • Name.wireDecode Method (from byte array)
  • Name.wireEncode Method
• Name.Component Class
  • Name.Component Constructors
    • Name.Component Constructor (copy optional byte array)
    • Name.Component Constructor (from Unicode string)
    • Name.Component Constructor (from Blob)
    • Name.Component Constructor (from Component)
  • Name.Component.compare Method
  • Name.Component.equals Method
  • Name.Component.fromImplicitSha256Digest Method
  • Name.Component.fromParametersSha256Digest Method
  • Name.Component.getOtherTypeCode Method
  • Name.Component.getSuccessor Method
  • Name.Component.getType Method
  • Name.Component.getValue Method
  • Name.Component.isGeneric Method
  • Name.Component.isImplicitSha256Digest Method
  • Name.Component.isParametersSha256Digest Method
  • Name.Component.toEscapedString Method
  • Name.Component From Naming Convention Value Methods
    • Name.Component.fromNumber Method
    • Name.Component.fromNumberWithMarker Method
    • Name.Component.fromSegment Method
    • Name.Component.fromSegmentOffset Method
    • Name.Component.fromSequenceNumber Method
    • Name.Component.fromTimestamp Method
    • Name.Component.fromVersion Method
  • Name.Component Is Naming Convention Value Methods
    • Name.Component.isSegment Method
    • Name.Component.isSegmentOffset Method
    • Name.Component.isSequenceNumber Method
    • Name.Component.isTimestamp Method
    • Name.Component.isVersion Method
  • Name.Component To Naming Convention Value Methods
    • Name.Component.toNumber Method
    • Name.Component.toNumberWithMarker Method
    • Name.Component.toSegment Method
    • Name.Component.toSegmentOffset Method
    • Name.Component.toSequenceNumber Method
    • Name.Component.toTimestamp Method
    • Name.Component.toVersion Method
• Interest Class
  • Interest Constructors
    • Interest Constructor (optional Name)
    • Interest Constructor (from URI)
    • Interest Constructor (copy)
  • Interest Get Methods
    • Interest.getCanBePrefix Method
    • Interest.getChildSelector Method
    • Interest.getDefaultCanBePrefix Method
    • Interest.getExclude Method
    • Interest.getForwardingHint Method
    • Interest.getIncomingFaceId Method
    • Interest.getInterestLifetimeMilliseconds Method
    • Interest.getKeyLocator Method
    • Interest.getMaxSuffixComponents Method
    • Interest.getMinSuffixComponents Method
    • Interest.getMustBeFresh Method
    • Interest.getName Method
    • Interest.getNonce Method
    • Interest.getParameters Method
  • Interest Set Methods
    • Interest.setCanBePrefix Method
    • Interest.setChildSelector Method
    • Interest.setDefaultCanBePrefix Method
    • Interest.setExclude Method
    • Interest.setForwardingHint Method
    • Interest.setInterestLifetimeMilliseconds Method
    • Interest.setKeyLocator Method
    • Interest.setMustBeFresh Method
    • Interest.setMaxSuffixComponents Method
    • Interest.setMinSuffixComponents Method
    • Interest.setName Method
    • Interest.setParameters Method
  • Interest.appendParametersDigestToName Method
  • Interest.matchesData Method
  • Interest.matchesName Method
  • Interest.refreshNonce Method
  • Interest.toUri Method
  • Interest.wireDecode Methods
    • Interest.wireDecode Method (from Blob)
    • Interest.wireDecode Method (copy from byte array)
  • Interest.wireEncode Method
• Exclude Class
  • Exclude Constructors
    • Exclude Constructor (default)
    • Exclude Constructor (copy)
  • Exclude.appendAny Method
  • Exclude.appendComponent Method
  • Exclude.clear Method
  • Exclude.get Method
  • Exclude.matches Method
  • Exclude.size Method
  • Exclude.toUri Method
• Exclude.Entry Class
  • Exclude.Entry.getType Method
  • Exclude.Entry.getComponent Method
• Data Class
  • Data Constructor
  • Data Get Methods
    • Data.getCongestionMark Method
    • Data.getContent Method
    • Data.getFullName Method
    • Data.getIncomingFaceId Method
    • Data.getMetaInfo Method
    • Data.getName Method
    • Data.getSignature Method
  • Data Set Methods
    • Data.setContent Method
    • Data.setMetaInfo Method
    • Data.setName Method
    • Data.setSignature Method
  • Data.wireDecode Methods
    • Data.wireDecode Method (from Blob)
    • Data.wireDecode Method (copy from byte array)
  • Data.wireEncode Method
• MetaInfo Class
  • MetaInfo Constructors
    • MetaInfo Constructor (default)
    • MetaInfo Constructor (copy)
  • MetaInfo Get Methods
    • MetaInfo.getFinalBlockId Method
    • MetaInfo.getFreshnessPeriod Method
    • MetaInfo.getOtherTypeCode Method
    • MetaInfo.getType Method
  • MetaInfo Set Methods
    • MetaInfo.setFinalBlockId Method
    • MetaInfo.setFreshnessPeriod Method
    • MetaInfo.setOtherTypeCode Method
    • MetaInfo.setType Method
• Signature Class
  • Signature.clone Method
• DigestSha256Signature Class
  • DigestSha256Signature Constructor
  • DigestSha256Signature Get Methods
    • DigestSha256Signature.getSignature Method
  • DigestSha256Signature Set Methods
    • DigestSha256Signature.setSignature Method
  • DigestSha256Signature.clone Method
• GenericSignature Class
  • GenericSignature Constructor
  • GenericSignature Get Methods
    • GenericSignature.getSignature Method
    • GenericSignature.getSignatureInfoEncoding Method
    • GenericSignature.getTypeCode Method
  • GenericSignature Set Methods
    • GenericSignature.setSignature Method
    • GenericSignature.setSignatureInfoEncoding Method
  • GenericSignature.clone Method
• Sha256WithRsaSignature Class
  • Sha256WithRsaSignature Constructor
  • Sha256WithRsaSignature Get Methods
    • Sha256WithRsaSignature.getKeyLocator Method
    • Sha256WithRsaSignature.getSignature Method
    • Sha256WithRsaSignature.getValidityPeriod Method
  • Sha256WithRsaSignature Set Methods
    • Sha256WithRsaSignature.setKeyLocator Method
    • Sha256WithRsaSignature.setSignature Method
    • Sha256WithRsaSignature.setValidityPeriod Method
  • Sha256WithRsaSignature.clone Method
• Sha256WithEcdsaSignature Class
  • Sha256WithEcdsaSignature Constructor
  • Sha256WithEcdsaSignature Get Methods
    • Sha256WithEcdsaSignature.getKeyLocator Method
    • Sha256WithEcdsaSignature.getSignature Method
    • Sha256WithEcdsaSignature.getValidityPeriod Method
  • Sha256WithEcdsaSignature Set Methods
    • Sha256WithEcdsaSignature.setKeyLocator Method
    • Sha256WithEcdsaSignature.setSignature Method
    • Sha256WithEcdsaSignature.setValidityPeriod Method
  • Sha256WithEcdsaSignature.clone Method
• KeyLocator Class
  • KeyLocator Constructors
    • KeyLocator Constructor (default)
    • KeyLocator Constructor (copy)
  • KeyLocator Get Methods
    • KeyLocator.getKeyData Method
    • KeyLocator.getKeyName Method
    • KeyLocator.getType Method
  • KeyLocator Set Methods
    • KeyLocator.setKeyData Method
    • KeyLocator.setKeyName Method
    • KeyLocator.setType Method
  • KeyLocator.clear Method
• InterestFilter Class
  • InterestFilter Constructors
    • InterestFilter Constructor (copy)
    • InterestFilter Constructor (from prefix Name)
    • InterestFilter Constructor (from prefix URI string)
  • InterestFilter.doesMatch Method
  • InterestFilter.getPrefix Method
  • InterestFilter.getRegexFilter Method
  • InterestFilter.hasRegexFilter Method
• Face Class
  • Face Constructors
    • Face Constructor (explicit Transport)
    • Face Constructor (default Transport)
  • Face.expressInterest Methods
    • Face.expressInterest Method (from Interest)
    • Face.expressInterest Method (from Name)
  • Face.getMaxNdnPacketSize Method
  • Face.isLocal Method
  • Face.makeCommandInterest Method
  • Face.processEvents Method
  • Face.putData Method
  • Face.putNack Method
  • Face.registerPrefix Method
  • Face.removePendingInterest Method
  • Face.removeRegisteredPrefix Method
  • Face.send Method
  • Face.setCommandCertificateName Method
  • Face.setCommandSigningInfo Method
  • Face.setInterestFilter Methods
    • Face.setInterestFilter Method (from InterestFilter)
    • Face.setInterestFilter Method (from prefix)
  • Face.setInterestLoopbackEnabled Method
  • Face.unsetInterestFilter Method
• Transport Class
  • Transport Constructor
  • Transport.ConnectionInfo Class
• Blob Class
  • Blob Constructors
    • Blob Constructor (from another Blob)
    • Blob Constructor (maybe point to an existing byte array)
    • Blob Constructor (copy an array)
    • Blob Constructor (from Unicode string)
  • Blob.buf Method
  • Blob.equals Method
  • Blob.isNull Method
  • Blob.size Method
• SignedBlob Class
  • SignedBlob.getSignedPortionBeginOffset Method
  • SignedBlob.getSignedPortionEndOffset Method
  • SignedBlob.signedBuf Method
  • SignedBlob.signedSize Method
• KeyChain Class
  • KeyChain Constructors
    • KeyChain Constructor (default)
    • KeyChain Constructor (locator strings)
  • KeyChain.getDefaultKeyParams Method
  • KeyChain.getPib Method
  • KeyChain.getTpm Method
  • KeyChain Identity Management
    • KeyChain.createIdentityV2 Method
    • KeyChain.deleteIdentity Method
    • KeyChain.setDefaultIdentity Method
  • KeyChain Key Management
    • KeyChain.createKey Method
    • KeyChain.deleteKey Method
    • KeyChain.setDefaultKey Method
  • KeyChain Certificate Management
    • KeyChain.addCertificate Method
    • KeyChain.deleteCertificate Method
    • KeyChain.setDefaultCertificate Method
  • KeyChain Signing Methods
    • KeyChain.sign (Data) Method
    • KeyChain.sign (Interest) Method
    • KeyChain.signWithSha256 (Data) Method
    • KeyChain.signWithSha256 (Interest) Method
• MemoryContentCache Class
  • MemoryContentCache Constructor
  • MemoryContentCache.add Method
  • MemoryContentCache.getMinimumCacheLifetime Method
  • MemoryContentCache.getStorePendingInterest Method
  • MemoryContentCache.registerPrefix Method
  • MemoryContentCache.setInterestFilter Methods
    • MemoryContentCache.setInterestFilter Method (from InterestFilter)
    • MemoryContentCache.setInterestFilter Method (from prefix)
  • MemoryContentCache.setMinimumCacheLifetime Method
  • MemoryContentCache.storePendingInterest Method
  • MemoryContentCache.unregisterAll Method
• ChronoSync2013 Class
  • ChronoSync Protocol
    • Broadcast prefix and application data prefix
    • The digest tree: Tracking each publisher’s sequence number
    • Syncing the digest tree root digest
    • Publishing new data
    • Packet encoding with Google protocol buffers
  • ChronoSync2013 Constructor
  • ChronoSync2013.getProducerSequenceNo Method
  • ChronoSync2013.getSequenceNo Method
  • ChronoSync2013.publishNextSequenceNo Method
  • ChronoSync2013.shutdown Method
• ChronoSync2013.SyncState Class
  • ChronoSync2013.SyncState.getApplicationInfo Method
  • ChronoSync2013.SyncState.getDataPrefix Method
  • ChronoSync2013.SyncState.getSequenceNo Method
  • ChronoSync2013.SyncState.getSessionNo Method
• ptr_lib (C++)
• Time representation
  • Milliseconds Typedef
  • MillisecondsSince1970 Typedef

• DelegationSet Class
• DelegationSet.Delegation Class
• RegistrationOptions Class
• NetworkNack Class
• TcpTransport.ConnectionInfo Class
• TcpTransport Class
• UdpTransport.ConnectionInfo Class
• UdpTransport Class

• Pib Class
• PibIdentity Class
• PibKey Class
• CertificateV2 Class
• ValidityPeriod Class
• Tpm Class
• Validator Class
• ValidatorConfig Class
• ValidatorNull Class
• CertificateFetcher Class
• CertificateFetcherFromNetwork Class
• CertificateFetcherOffline Class
• ValidationError Class

• AccessManagerV2 Class
• DecryptorV2 Class
• EncryptorV2 Class
• EncryptedContent Class