ndn Namespace Reference

Copyright (c) 2013-2017 Regents of the University of California. More...

Namespaces

 command_interest
 
 detail
 
 dns
 
 encoding
 
 ethernet
 
 io
 
 ip
 
 literals
 
 lp
 
 mgmt
 
 name
 
 net
 
 nfd
 
 random
 
 security
 
 signed_interest
 
 time
 
 tlv
 Namespace defining NDN Packet Format related constants and procedures.
 
 util
 

Classes

class  AsHex
 Helper class to convert a number to hexadecimal format, for use with stream insertion operators. More...
 
class  bad_optional_access
 
class  Block
 Represents a TLV element of NDN packet format. More...
 
class  Buffer
 General-purpose automatically managed/resized buffer. More...
 
class  ConfigFile
 System configuration file for NDN platform. More...
 
class  Data
 Represents a Data packet. More...
 
struct  Delegation
 represents a delegation More...
 
class  DelegationList
 represents a list of Delegations More...
 
class  DigestSha256
 Represents a signature of DigestSha256 type. More...
 
class  Exclude
 Represents Exclude selector in NDN Interest. More...
 
class  Face
 Provide a communication channel with local or remote NDN forwarder. More...
 
class  FaceUri
 represents the underlying protocol and address used by a Face More...
 
struct  in_place_t
 
class  InMemoryStorage
 Represents in-memory storage. More...
 
class  InMemoryStorageEntry
 Represents an in-memory storage entry. More...
 
class  InMemoryStorageFifo
 Provides in-memory storage employing First-In-First-Out (FIFO) replacement policy. More...
 
class  InMemoryStorageLfu
 Provides an in-memory storage with Least Frequently Used (LFU) replacement policy. More...
 
class  InMemoryStorageLru
 Provides in-memory storage employing Least Recently Used (LRU) replacement policy. More...
 
class  InMemoryStoragePersistent
 Provides application cache with persistent storage, of which no replacement policy will be employed. More...
 
class  Interest
 Represents an Interest packet. More...
 
class  InterestFilter
 declares the set of Interests a producer can serve, which starts with a name prefix, plus an optional regular expression More...
 
class  KeyLocator
 
class  KeyParams
 Base class of key parameters. More...
 
class  Link
 represents a Link object More...
 
class  MetaInfo
 An MetaInfo holds the meta info which is signed inside the data packet. More...
 
class  Name
 Represents an absolute name. More...
 
class  NotificationStreamItem
 concept check for an item in a Notification Stream More...
 
class  nullopt_t
 
class  OBufferStream
 implements an output stream that constructs ndn::Buffer More...
 
class  optional
 
class  ostream_joiner
 
class  PacketBase
 base class to allow simple management of packet tags More...
 
class  RegexBackrefManager
 
class  RegexBackrefMatcher
 
class  RegexComponentMatcher
 
class  RegexComponentSetMatcher
 
class  RegexMatcher
 
class  RegexPatternListMatcher
 
class  RegexPseudoMatcher
 
class  RegexRepeatMatcher
 
class  RegexTopMatcher
 
class  Selectors
 Abstraction implementing Interest selectors. More...
 
class  Signature
 Holds SignatureInfo and SignatureValue in a Data packet. More...
 
class  SignatureInfo
 Represents a SignatureInfo TLV element. More...
 
class  SignatureSha256WithEcdsa
 Represents a signature of Sha256WithEcdsa type. More...
 
class  SignatureSha256WithRsa
 Represents a signature of Sha256WithRsa type. More...
 
class  SimplePublicKeyParams
 SimplePublicKeyParams is a template for public keys with only one parameter: size. More...
 
class  SimpleSymmetricKeyParams
 SimpleSymmetricKeyParams is a template for symmetric keys with only one parameter: size. More...
 
class  SimpleTag
 provides a tag type for simple types More...
 
class  StatusDatasetItem
 concept check for an item in a Status Dataset More...
 
class  StreamTransportImpl
 implementation detail of a Boost.Asio-based stream-oriented transport More...
 
class  StreamTransportWithResolverImpl
 implementation detail of a Boost.Asio-based stream-oriented transport with resolver support More...
 
class  StringHelperError
 
class  Tag
 Base class for packet tags that can hold any arbitrary information. More...
 
class  TagHost
 Base class to store tag information (e.g., inside Interest and Data packets) More...
 
class  TcpTransport
 a transport using TCP socket More...
 
class  Transport
 provides TLV-block delivery service More...
 
class  UnixTransport
 a transport using Unix stream socket More...
 
class  WireDecodable
 a concept check for TLV abstraction with .wireDecode method and constructible from Block More...
 
class  WireEncodable
 a concept check for TLV abstraction with .wireEncode method More...
 
class  WireEncodableWithEncodingBuffer
 a concept check for TLV abstraction with .wireEncode method More...
 

Typedefs

typedef SimpleSymmetricKeyParams< detail::AesKeyParamsInfoAesKeyParams
 AesKeyParams carries parameters for AES key. More...
 
using BufferPtr = shared_ptr< Buffer >
 
using CanonizeProviders = boost::mpl::vector< UdpCanonizeProvider *, TcpCanonizeProvider *, EtherCanonizeProvider *, DevCanonizeProvider *, UdpDevCanonizeProvider * >
 
using CanonizeProviderTable = std::map< std::string, shared_ptr< CanonizeProvider >>
 
using ConstBufferPtr = shared_ptr< const Buffer >
 
typedef function< void(const Interest &, const Data &)> DataCallback
 Callback invoked when expressed Interest gets satisfied with a Data packet. More...
 
typedef SimplePublicKeyParams< detail::EcKeyParamsInfoEcKeyParams
 EcKeyParams carries parameters for EC key. More...
 
typedef function< void(const InterestFilter &, const Interest &)> InterestCallback
 Callback invoked when incoming Interest matches the specified InterestFilter. More...
 
typedef function< void(const Interest &, const lp::Nack &)> NackCallback
 Callback invoked when Nack is sent in response to expressed Interest. More...
 
using PartialName = Name
 Represents an arbitrary sequence of name components. More...
 
typedef RegexTopMatcher Regex
 
typedef function< void(const Name &, const std::string &)> RegisterPrefixFailureCallback
 Callback invoked when registerPrefix or setInterestFilter command fails. More...
 
typedef function< void(const Name &)> RegisterPrefixSuccessCallback
 Callback invoked when registerPrefix or setInterestFilter command succeeds. More...
 
typedef SimplePublicKeyParams< detail::RsaKeyParamsInfoRsaKeyParams
 RsaKeyParams carries parameters for RSA key. More...
 
typedef function< void(const Interest &)> TimeoutCallback
 Callback invoked when expressed Interest times out. More...
 
typedef function< void(const std::string &)> UnregisterPrefixFailureCallback
 Callback invoked when unregisterPrefix or unsetInterestFilter command fails. More...
 
typedef function< void()> UnregisterPrefixSuccessCallback
 Callback invoked when unregisterPrefix or unsetInterestFilter command succeeds. More...
 

Enumerations

enum  AclType {
  AclType::NONE,
  AclType::PUBLIC,
  AclType::PRIVATE
}
 
enum  BlockCipherAlgorithm {
  BlockCipherAlgorithm::NONE,
  BlockCipherAlgorithm::AES_CBC
}
 
enum  CipherOperator {
  CipherOperator::DECRYPT = 0,
  CipherOperator::ENCRYPT = 1
}
 
enum  DigestAlgorithm {
  DigestAlgorithm::NONE = 0,
  DigestAlgorithm::SHA224 = 2,
  DigestAlgorithm::SHA256 = 1,
  DigestAlgorithm::SHA384 = 3,
  DigestAlgorithm::SHA512 = 4,
  DigestAlgorithm::BLAKE2B_512 = 10,
  DigestAlgorithm::BLAKE2S_256 = 11
}
 
enum  KeyClass {
  KeyClass::NONE,
  KeyClass::PUBLIC,
  KeyClass::PRIVATE,
  KeyClass::SYMMETRIC
}
 
enum  KeyIdType {
  KeyIdType::USER_SPECIFIED = 0,
  KeyIdType::SHA256 = 1,
  KeyIdType::RANDOM = 2
}
 The type of KeyId component in a key name. More...
 
enum  KeyType {
  KeyType::NONE = 0,
  KeyType::RSA = 1,
  KeyType::EC = 2,
  KeyType::AES = 128
}
 The type of a cryptographic key. More...
 

Functions

template<typename T , typename Compare >
constexpr const T & clamp (const T &v, const T &lo, const T &hi, Compare comp)
 
template<typename T >
constexpr const T & clamp (const T &v, const T &lo, const T &hi)
 
template size_t Data::wireEncode< encoding::EncoderTag > (EncodingBuffer &, bool) const
 
template size_t Data::wireEncode< encoding::EstimatorTag > (EncodingEstimator &, bool) const
 
template size_t DelegationList::wireEncode< encoding::EncoderTag > (EncodingBuffer &, uint32_t) const
 
template size_t DelegationList::wireEncode< encoding::EstimatorTag > (EncodingEstimator &, uint32_t) const
 
std::string escape (const std::string &str)
 Percent-encode a string. More...
 
void escape (std::ostream &os, const char *str, size_t len)
 
template size_t Exclude::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t Exclude::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template<typename NetPkt >
static void extractLpLocalFields (NetPkt &netPacket, const lp::Packet &lpPacket)
 extract local fields from NDNLPv2 packet and tag onto a network layer packet More...
 
shared_ptr< BufferfromHex (const std::string &hexString)
 Convert the hex string to buffer. More...
 
constexpr int fromHexChar (char c) noexcept
 Convert the hex character c to an integer in [0, 15], or -1 if it's not a hex character. More...
 
static const CanonizeProvider * getCanonizeProvider (const std::string &scheme)
 
template size_t Interest::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t Interest::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template size_t KeyLocator::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t KeyLocator::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template<typename T >
constexpr optional< typename std::decay< T >::type > make_optional (T &&value)
 
template<typename T , typename... Args>
constexpr optional< T > make_optional (Args &&...args)
 
template<typename CharT , typename Traits , typename DelimT >
ostream_joiner< typename std::decay< DelimT >::type, CharT, Traits > make_ostream_joiner (std::basic_ostream< CharT, Traits > &os, DelimT &&delimiter)
 
template<typename T , typename... Args>
unique_ptr< T > make_unique (Args &&...args)
 
template size_t MetaInfo::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t MetaInfo::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template size_t Name::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t Name::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
bool operator!= (const Delegation &lhs, const Delegation &rhs)
 
template<typename T >
constexpr bool operator!= (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator!= (const Signature &lhs, const Signature &rhs)
 
bool operator!= (const SignatureInfo &lhs, const SignatureInfo &rhs)
 
bool operator!= (const DelegationList &lhs, const DelegationList &rhs)
 
bool operator!= (const Data &lhs, const Data &rhs)
 
bool operator!= (const Interest &lhs, const Interest &rhs)
 
bool operator!= (const Block &lhs, const Block &rhs)
 
bool operator!= (const Name &lhs, const Name &rhs)
 
bool operator< (const Delegation &lhs, const Delegation &rhs)
 
template<typename T >
constexpr bool operator< (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator< (const Name &lhs, const Name &rhs)
 
std::ostream & operator<< (std::ostream &os, KeyIdType keyIdType)
 
std::ostream & operator<< (std::ostream &os, const AsHex &hex)
 
std::ostream & operator<< (std::ostream &os, KeyType keyType)
 
std::ostream & operator<< (std::ostream &os, const Delegation &del)
 
std::ostream & operator<< (std::ostream &os, KeyClass keyClass)
 
std::ostream & operator<< (std::ostream &os, const InterestFilter &filter)
 
std::ostream & operator<< (std::ostream &os, DigestAlgorithm algorithm)
 
std::ostream & operator<< (std::ostream &os, const RegexMatcher &rm)
 
std::ostream & operator<< (std::ostream &os, const Exclude::Range &range)
 
std::ostream & operator<< (std::ostream &os, BlockCipherAlgorithm algorithm)
 
std::ostream & operator<< (std::ostream &os, CipherOperator op)
 
std::ostream & operator<< (std::ostream &os, AclType aclType)
 
std::ostream & operator<< (std::ostream &os, const KeyLocator &keyLocator)
 
std::ostream & operator<< (std::ostream &os, const FaceUri &uri)
 
std::ostream & operator<< (std::ostream &os, const SignatureInfo &info)
 
std::ostream & operator<< (std::ostream &os, const DelegationList &dl)
 
std::ostream & operator<< (std::ostream &os, const MetaInfo &info)
 
std::ostream & operator<< (std::ostream &os, const Name &name)
 Print URI representation of a name. More...
 
std::ostream & operator<< (std::ostream &os, const Exclude &exclude)
 
std::ostream & operator<< (std::ostream &os, const Data &data)
 
std::ostream & operator<< (std::ostream &os, const Interest &interest)
 
std::ostream & operator<< (std::ostream &os, const Block &block)
 
bool operator<= (const Delegation &lhs, const Delegation &rhs)
 
template<typename T >
constexpr bool operator<= (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator<= (const Name &lhs, const Name &rhs)
 
bool operator== (const Delegation &lhs, const Delegation &rhs)
 
bool operator== (const Exclude::ExcludeComponent &a, const Exclude::ExcludeComponent &b)
 
bool operator== (const Signature &lhs, const Signature &rhs)
 
template<typename T >
constexpr bool operator== (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator== (const SignatureInfo &lhs, const SignatureInfo &rhs)
 
bool operator== (const DelegationList &lhs, const DelegationList &rhs)
 compare whether two DelegationLists are equal More...
 
bool operator== (const Data &lhs, const Data &rhs)
 
bool operator== (const Interest &lhs, const Interest &rhs)
 
bool operator== (const Block &lhs, const Block &rhs)
 Compare whether two Blocks have same TLV-TYPE, TLV-LENGTH, and TLV-VALUE. More...
 
bool operator== (const Name &lhs, const Name &rhs)
 
bool operator> (const Exclude::ExcludeComponent &a, const Exclude::ExcludeComponent &b)
 
bool operator> (const Delegation &lhs, const Delegation &rhs)
 
template<typename T >
constexpr bool operator> (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator> (const Name &lhs, const Name &rhs)
 
bool operator>= (const Delegation &lhs, const Delegation &rhs)
 
template<typename T >
constexpr bool operator>= (const optional< T > &lhs, const optional< T > &rhs)
 
bool operator>= (const Name &lhs, const Name &rhs)
 
std::istream & operator>> (std::istream &is, Name &name)
 Parse URI from stream as Name. More...
 
void printHex (std::ostream &os, uint64_t num, bool wantUpperCase=false)
 Output the hex representation of num to the output stream os. More...
 
void printHex (std::ostream &os, const uint8_t *buffer, size_t length, bool wantUpperCase=true)
 Output the hex representation of the bytes in buffer to the output stream os. More...
 
void printHex (std::ostream &os, const Buffer &buffer, bool wantUpperCase=true)
 Output the hex representation of the bytes in buffer to the output stream os. More...
 
template size_t Selectors::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t Selectors::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template size_t SignatureInfo::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t SignatureInfo::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
template<typename V >
std::string to_string (const V &v)
 
std::string toHex (const uint8_t *buffer, size_t length, bool wantUpperCase=true)
 Return a string containing the hex representation of the bytes in buffer. More...
 
std::string toHex (const Buffer &buffer, bool wantUpperCase=true)
 Return a string containing the hex representation of the bytes in buffer. More...
 
constexpr char toHexChar (unsigned int n, bool wantUpperCase=true) noexcept
 Convert (the least significant nibble of) n to the corresponding hex character. More...
 
std::string unescape (const std::string &str)
 Decode a percent-encoded string. More...
 
void unescape (std::ostream &os, const char *str, size_t len)
 

Variables

static const uint32_t AES_KEY_SIZES [] = {128, 192, 256}
 
static constexpr size_t BOOST_REGEXP_MARK_COUNT_CORRECTION
 
const int DEFAULT_CHILD_SELECTOR = 0
 
const time::milliseconds DEFAULT_FRESHNESS_PERIOD = time::milliseconds::zero()
 
const time::milliseconds DEFAULT_INTEREST_LIFETIME = 4_s
 default value for InterestLifetime More...
 
static const uint32_t DEFAULT_RSA_KEY_SIZE = 2048
 
static const uint32_t EC_KEY_SIZES [] = {256, 384}
 
constexpr in_place_t in_place {}
 
const size_t MAX_NDN_PACKET_SIZE = 8800
 practical limit of network layer packet size More...
 
const size_t MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE
 
static const uint32_t MIN_RSA_KEY_SIZE = 1024
 
constexpr nullopt_t nullopt {0}
 

Detailed Description

Copyright (c) 2013-2017 Regents of the University of California.

Copyright (c) 2013-2014 Regents of the University of California.

Copyright (c) 2014-2017 Regents of the University of California, Arizona Board of Regents, Colorado State University, University Pierre & Marie Curie, Sorbonne University, Washington University in St.

Copyright (c) 2013-2015 Regents of the University of California.

Copyright (c) 2013-2016 Regents of the University of California.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Alexander Afanasyev http://lasr.cs.ucla.edu/afanasyev/index.html

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Eric Newberry enewb.nosp@m.erry.nosp@m.@emai.nosp@m.l.ar.nosp@m.izona.nosp@m..edu

Louis, Beijing Institute of Technology, The University of Memphis.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Davide Pesavento david.nosp@m.e.pe.nosp@m.saven.nosp@m.to@l.nosp@m.ip6.f.nosp@m.r

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Alexander Afanasyev alexa.nosp@m.nder.nosp@m..afan.nosp@m.asye.nosp@m.v@ucl.nosp@m.a.ed.nosp@m.u
Davide Pesavento david.nosp@m.e.pe.nosp@m.saven.nosp@m.to@l.nosp@m.ip6.f.nosp@m.r

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Zhiyi Zhang dream.nosp@m.erba.nosp@m.rrych.nosp@m.ang@.nosp@m.gmail.nosp@m..com
Yingdi Yu http://irl.cs.ucla.edu/~yingdi/

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library 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.

ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

Author
Yingdi Yu http://irl.cs.ucla.edu/~yingdi/

Typedef Documentation

AesKeyParams carries parameters for AES key.

Definition at line 288 of file key-params.hpp.

using ndn::BufferPtr = typedef shared_ptr<Buffer>

Definition at line 88 of file buffer.hpp.

using ndn::CanonizeProviders = typedef boost::mpl::vector<UdpCanonizeProvider*, TcpCanonizeProvider*, EtherCanonizeProvider*, DevCanonizeProvider*, UdpDevCanonizeProvider*>

Definition at line 584 of file face-uri.cpp.

using ndn::CanonizeProviderTable = typedef std::map<std::string, shared_ptr<CanonizeProvider>>

Definition at line 585 of file face-uri.cpp.

using ndn::ConstBufferPtr = typedef shared_ptr<const Buffer>

Definition at line 89 of file buffer.hpp.

typedef function<void(const Interest&, const Data&)> ndn::DataCallback

Callback invoked when expressed Interest gets satisfied with a Data packet.

Definition at line 50 of file face.hpp.

EcKeyParams carries parameters for EC key.

Definition at line 206 of file key-params.hpp.

typedef function<void(const InterestFilter&, const Interest&)> ndn::InterestCallback

Callback invoked when incoming Interest matches the specified InterestFilter.

Definition at line 65 of file face.hpp.

typedef function<void(const Interest&, const lp::Nack&)> ndn::NackCallback

Callback invoked when Nack is sent in response to expressed Interest.

Definition at line 55 of file face.hpp.

using ndn::PartialName = typedef Name

Represents an arbitrary sequence of name components.

Definition at line 38 of file name.hpp.

Definition at line 31 of file regex.hpp.

typedef function<void(const Name&, const std::string&)> ndn::RegisterPrefixFailureCallback

Callback invoked when registerPrefix or setInterestFilter command fails.

Definition at line 75 of file face.hpp.

typedef function<void(const Name&)> ndn::RegisterPrefixSuccessCallback

Callback invoked when registerPrefix or setInterestFilter command succeeds.

Definition at line 70 of file face.hpp.

RsaKeyParams carries parameters for RSA key.

Definition at line 203 of file key-params.hpp.

typedef function<void(const Interest&)> ndn::TimeoutCallback

Callback invoked when expressed Interest times out.

Definition at line 60 of file face.hpp.

typedef function<void(const std::string&)> ndn::UnregisterPrefixFailureCallback

Callback invoked when unregisterPrefix or unsetInterestFilter command fails.

Definition at line 85 of file face.hpp.

typedef function<void()> ndn::UnregisterPrefixSuccessCallback

Callback invoked when unregisterPrefix or unsetInterestFilter command succeeds.

Definition at line 80 of file face.hpp.

Enumeration Type Documentation

enum ndn::AclType
strong
Enumerator
NONE 
PUBLIC 
PRIVATE 

Definition at line 134 of file security-common.hpp.

Enumerator
NONE 
AES_CBC 

Definition at line 118 of file security-common.hpp.

enum ndn::CipherOperator
strong
Enumerator
DECRYPT 
ENCRYPT 

Definition at line 126 of file security-common.hpp.

enum ndn::DigestAlgorithm
strong
Enumerator
NONE 
SHA224 
SHA256 
SHA384 
SHA512 
BLAKE2B_512 
BLAKE2S_256 

Definition at line 105 of file security-common.hpp.

enum ndn::KeyClass
strong
Enumerator
NONE 
PUBLIC 
PRIVATE 
SYMMETRIC 

Definition at line 95 of file security-common.hpp.

enum ndn::KeyIdType
strong

The type of KeyId component in a key name.

Enumerator
USER_SPECIFIED 

User-specified key ID.

It is user's responsibility to assure the uniqueness of the key names.

SHA256 

Use the SHA256 hash of the public key as the key id.

This KeyId type guarantees the uniqueness of the key names.

RANDOM 

Use a 64-bit random number as the key id.

This KeyId provides roughly uniqueness of the key names.

Definition at line 58 of file security-common.hpp.

enum ndn::KeyType
strong

The type of a cryptographic key.

Enumerator
NONE 

Unknown key type.

RSA 

RSA key, supports sign/verify and encrypt/decrypt operations.

EC 

Elliptic Curve key (e.g. for ECDSA), supports sign/verify operations.

AES 

AES key, supports encrypt/decrypt operations.

Definition at line 85 of file security-common.hpp.

Function Documentation

template<typename T , typename Compare >
constexpr const T& ndn::clamp ( const T &  v,
const T &  lo,
const T &  hi,
Compare  comp 
)

Definition at line 118 of file backports.hpp.

template<typename T >
constexpr const T& ndn::clamp ( const T &  v,
const T &  lo,
const T &  hi 
)

Definition at line 125 of file backports.hpp.

template size_t ndn::Data::wireEncode< encoding::EncoderTag > ( EncodingBuffer &  ,
bool   
) const
template size_t ndn::Data::wireEncode< encoding::EstimatorTag > ( EncodingEstimator &  ,
bool   
) const
template size_t ndn::DelegationList::wireEncode< encoding::EncoderTag > ( EncodingBuffer &  ,
uint32_t   
) const
template size_t ndn::DelegationList::wireEncode< encoding::EstimatorTag > ( EncodingEstimator &  ,
uint32_t   
) const
std::string ndn::escape ( const std::string &  str)

Percent-encode a string.

See also
RFC 3986 section 2

This function will encode all characters that are not one of the following: ALPHA ("a" to "z" and "A" to "Z") / DIGIT (0 to 9) / "-" / "." / "_" / "~"

The hex encoding uses the numbers 0-9 and the uppercase letters A-F.

Examples:

escape("hello world") == "hello%20world"
escape("100%") == "100%25"

Definition at line 97 of file string-helper.cpp.

void ndn::escape ( std::ostream &  os,
const char *  str,
size_t  len 
)

Definition at line 105 of file string-helper.cpp.

template size_t ndn::Exclude::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::Exclude::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template<typename NetPkt >
static void ndn::extractLpLocalFields ( NetPkt &  netPacket,
const lp::Packet lpPacket 
)
static

extract local fields from NDNLPv2 packet and tag onto a network layer packet

Definition at line 374 of file face.cpp.

shared_ptr< Buffer > ndn::fromHex ( const std::string &  hexString)

Convert the hex string to buffer.

Parameters
hexStringsequence of pairs of hex numbers (lower and upper case can be mixed) without any whitespace separators (e.g., "48656C6C6F2C20776F726C6421")
Exceptions
StringHelperErrorif input is invalid

Definition at line 81 of file string-helper.cpp.

constexpr int ndn::fromHexChar ( char  c)
noexcept

Convert the hex character c to an integer in [0, 15], or -1 if it's not a hex character.

Definition at line 168 of file string-helper.hpp.

static const CanonizeProvider* ndn::getCanonizeProvider ( const std::string &  scheme)
static

Definition at line 615 of file face-uri.cpp.

template size_t ndn::Interest::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::Interest::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template size_t ndn::KeyLocator::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::KeyLocator::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template<typename T >
constexpr optional<typename std::decay<T>::type> ndn::make_optional ( T &&  value)

Definition at line 340 of file backports-optional.hpp.

template<typename T , typename... Args>
constexpr optional<T> ndn::make_optional ( Args &&...  args)

Definition at line 347 of file backports-optional.hpp.

template<typename CharT , typename Traits , typename DelimT >
ostream_joiner<typename std::decay<DelimT>::type, CharT, Traits> ndn::make_ostream_joiner ( std::basic_ostream< CharT, Traits > &  os,
DelimT &&  delimiter 
)
inline

Definition at line 117 of file backports-ostream-joiner.hpp.

template<typename T , typename... Args>
unique_ptr<T> ndn::make_unique ( Args &&...  args)
inline

Definition at line 96 of file backports.hpp.

template size_t ndn::MetaInfo::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::MetaInfo::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template size_t ndn::Name::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::Name::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
bool ndn::operator!= ( const Delegation lhs,
const Delegation rhs 
)
inline

Definition at line 42 of file delegation.hpp.

template<typename T >
constexpr bool ndn::operator!= ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 305 of file backports-optional.hpp.

bool ndn::operator!= ( const Signature lhs,
const Signature rhs 
)
inline

Definition at line 162 of file signature.hpp.

bool ndn::operator!= ( const SignatureInfo lhs,
const SignatureInfo rhs 
)
inline

Definition at line 171 of file signature-info.hpp.

bool ndn::operator!= ( const DelegationList lhs,
const DelegationList rhs 
)
inline

Definition at line 251 of file delegation-list.hpp.

bool ndn::operator!= ( const Data lhs,
const Data rhs 
)
inline

Definition at line 280 of file data.hpp.

bool ndn::operator!= ( const Interest lhs,
const Interest rhs 
)
inline

Definition at line 415 of file interest.hpp.

bool ndn::operator!= ( const Block lhs,
const Block rhs 
)
inline

Definition at line 448 of file block.hpp.

bool ndn::operator!= ( const Name lhs,
const Name rhs 
)
inline

Definition at line 572 of file name.hpp.

bool ndn::operator< ( const Delegation lhs,
const Delegation rhs 
)

Definition at line 36 of file delegation.cpp.

template<typename T >
constexpr bool ndn::operator< ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 312 of file backports-optional.hpp.

bool ndn::operator< ( const Name lhs,
const Name rhs 
)
inline

Definition at line 584 of file name.hpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
KeyIdType  keyIdType 
)

Definition at line 29 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const AsHex hex 
)

Definition at line 35 of file string-helper.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
KeyType  keyType 
)

Definition at line 43 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Delegation del 
)

Definition at line 50 of file delegation.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
KeyClass  keyClass 
)

Definition at line 59 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const InterestFilter filter 
)

Definition at line 66 of file interest-filter.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
DigestAlgorithm  algorithm 
)

Definition at line 75 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const RegexMatcher rm 
)

Definition at line 75 of file regex-matcher.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Exclude::Range range 
)

Definition at line 81 of file exclude.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
BlockCipherAlgorithm  algorithm 
)

Definition at line 97 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
CipherOperator  op 
)

Definition at line 109 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
AclType  aclType 
)

Definition at line 121 of file security-common.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const KeyLocator keyLocator 
)

Definition at line 190 of file key-locator.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const FaceUri uri 
)

Definition at line 213 of file face-uri.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const SignatureInfo info 
)

Definition at line 230 of file signature-info.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const DelegationList dl 
)

Definition at line 241 of file delegation-list.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const MetaInfo info 
)

Definition at line 244 of file meta-info.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Name name 
)

Print URI representation of a name.

See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#ndn-uri-scheme

Definition at line 304 of file name.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Exclude exclude 
)

Definition at line 332 of file exclude.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Data data 
)

Definition at line 337 of file data.cpp.

std::ostream & ndn::operator<< ( std::ostream &  os,
const Interest interest 
)

Definition at line 497 of file interest.cpp.

std::ostream& ndn::operator<< ( std::ostream &  os,
const Block block 
)

Default-constructed block is printed as: [invalid]. Zero-length block is printed as: TT[empty], where TT is TLV-TYPE in decimal. Non-zero-length block on which Block::parse is not called is printed as: TT[LL]=VVVV, where LL is TLV-LENGTH in decimal, and VVVV is TLV-VALUE is hexadecimal. Block on which Block::parse has been called in printed as: TT[LL]={SUB,SUB}, where SUB is a sub-element printed using this format.

Definition at line 521 of file block.cpp.

bool ndn::operator<= ( const Delegation lhs,
const Delegation rhs 
)

Definition at line 43 of file delegation.cpp.

template<typename T >
constexpr bool ndn::operator<= ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 319 of file backports-optional.hpp.

bool ndn::operator<= ( const Name lhs,
const Name rhs 
)
inline

Definition at line 578 of file name.hpp.

bool ndn::operator== ( const Delegation lhs,
const Delegation rhs 
)

Definition at line 29 of file delegation.cpp.

bool ndn::operator== ( const Exclude::ExcludeComponent a,
const Exclude::ExcludeComponent b 
)

Definition at line 45 of file exclude.cpp.

bool ndn::operator== ( const Signature lhs,
const Signature rhs 
)

Definition at line 68 of file signature.cpp.

template<typename T >
constexpr bool ndn::operator== ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 298 of file backports-optional.hpp.

bool ndn::operator== ( const SignatureInfo lhs,
const SignatureInfo rhs 
)

Definition at line 221 of file signature-info.cpp.

bool ndn::operator== ( const DelegationList lhs,
const DelegationList rhs 
)

compare whether two DelegationLists are equal

Note
Order matters! If two DelegationLists contain the same Delegations but at least one is unsorted, they may compare unequal if the Delegations appear in different order.

Definition at line 235 of file delegation-list.cpp.

bool ndn::operator== ( const Data lhs,
const Data rhs 
)

Definition at line 328 of file data.cpp.

bool ndn::operator== ( const Interest lhs,
const Interest rhs 
)
inline

Definition at line 409 of file interest.hpp.

bool ndn::operator== ( const Block lhs,
const Block rhs 
)

Compare whether two Blocks have same TLV-TYPE, TLV-LENGTH, and TLV-VALUE.

Definition at line 512 of file block.cpp.

bool ndn::operator== ( const Name lhs,
const Name rhs 
)
inline

Definition at line 566 of file name.hpp.

bool ndn::operator> ( const Exclude::ExcludeComponent a,
const Exclude::ExcludeComponent b 
)

Definition at line 52 of file exclude.cpp.

bool ndn::operator> ( const Delegation lhs,
const Delegation rhs 
)
inline

Definition at line 54 of file delegation.hpp.

template<typename T >
constexpr bool ndn::operator> ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 326 of file backports-optional.hpp.

bool ndn::operator> ( const Name lhs,
const Name rhs 
)
inline

Definition at line 596 of file name.hpp.

bool ndn::operator>= ( const Delegation lhs,
const Delegation rhs 
)
inline

Definition at line 60 of file delegation.hpp.

template<typename T >
constexpr bool ndn::operator>= ( const optional< T > &  lhs,
const optional< T > &  rhs 
)

Definition at line 333 of file backports-optional.hpp.

bool ndn::operator>= ( const Name lhs,
const Name rhs 
)
inline

Definition at line 590 of file name.hpp.

std::istream & ndn::operator>> ( std::istream &  is,
Name name 
)

Parse URI from stream as Name.

See also
https://named-data.net/doc/NDN-packet-spec/current/name.html#ndn-uri-scheme

Definition at line 319 of file name.cpp.

void ndn::printHex ( std::ostream &  os,
uint64_t  num,
bool  wantUpperCase = false 
)

Output the hex representation of num to the output stream os.

Parameters
osOutput stream
numNumber to print in hexadecimal format
wantUpperCaseif true, print uppercase hex chars; the default is to use lowercase

The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 42 of file string-helper.cpp.

void ndn::printHex ( std::ostream &  os,
const uint8_t *  buffer,
size_t  length,
bool  wantUpperCase = true 
)

Output the hex representation of the bytes in buffer to the output stream os.

Parameters
osOutput stream
bufferPointer to an array of bytes
lengthSize of the array
wantUpperCaseif true (the default) print uppercase hex chars

Examples:

printHex(std::cout, "Hello, World!"); // outputs "48656C6C6F2C20776F726C6421"
printHex(std::cout, "Hello, World!", false); // outputs "48656c6c6f2c20776f726c6421"

Each octet is always represented as two hex characters ("00" for octet==0).

The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 53 of file string-helper.cpp.

void ndn::printHex ( std::ostream &  os,
const Buffer buffer,
bool  wantUpperCase = true 
)

Output the hex representation of the bytes in buffer to the output stream os.

Parameters
osOutput stream
bufferBuffer of bytes to print in hexadecimal format
wantUpperCaseif true (the default) print uppercase hex chars

Definition at line 61 of file string-helper.cpp.

template size_t ndn::Selectors::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::Selectors::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template size_t ndn::SignatureInfo::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const
template size_t ndn::SignatureInfo::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const
template<typename V >
std::string ndn::to_string ( const V &  v)
inline

Definition at line 107 of file backports.hpp.

std::string ndn::toHex ( const uint8_t *  buffer,
size_t  length,
bool  wantUpperCase = true 
)

Return a string containing the hex representation of the bytes in buffer.

Parameters
bufferPointer to an array of bytes
lengthSize of the array
wantUpperCaseif true (the default) use uppercase hex chars

Examples:

toHex("Hello, World!") == "48656C6C6F2C20776F726C6421"
toHex("Hello, World!", false) == "48656c6c6f2c20776f726c6421"

Each octet is always represented as two hex characters ("00" for octet==0).

The output string is a continuous sequence of hex characters without any whitespace separators.

Definition at line 67 of file string-helper.cpp.

std::string ndn::toHex ( const Buffer buffer,
bool  wantUpperCase = true 
)

Return a string containing the hex representation of the bytes in buffer.

Parameters
bufferBuffer of bytes to convert to hexadecimal format
wantUpperCaseif true (the default) use uppercase hex chars

Definition at line 75 of file string-helper.cpp.

constexpr char ndn::toHexChar ( unsigned int  n,
bool  wantUpperCase = true 
)
noexcept

Convert (the least significant nibble of) n to the corresponding hex character.

Definition at line 157 of file string-helper.hpp.

std::string ndn::unescape ( const std::string &  str)

Decode a percent-encoded string.

See also
RFC 3986 section 2

When % is not followed by two hex characters, the output is not transformed.

Examples:

unescape("hello%20world") == "hello world"
unescape("hello%20world%FooBar") == "hello world%FooBar"

Definition at line 126 of file string-helper.cpp.

void ndn::unescape ( std::ostream &  os,
const char *  str,
size_t  len 
)

Definition at line 134 of file string-helper.cpp.

Variable Documentation

const uint32_t ndn::AES_KEY_SIZES[] = {128, 192, 256}
static

Definition at line 29 of file key-params.cpp.

constexpr size_t ndn::BOOST_REGEXP_MARK_COUNT_CORRECTION
static
Initial value:
=
1

Definition at line 35 of file regex-component-matcher.cpp.

const int ndn::DEFAULT_CHILD_SELECTOR = 0

Definition at line 31 of file selectors.hpp.

const time::milliseconds ndn::DEFAULT_FRESHNESS_PERIOD = time::milliseconds::zero()

Definition at line 34 of file meta-info.hpp.

const unspecified_duration_type ndn::DEFAULT_INTEREST_LIFETIME = 4_s

default value for InterestLifetime

Definition at line 38 of file interest.hpp.

const uint32_t ndn::DEFAULT_RSA_KEY_SIZE = 2048
static

Definition at line 27 of file key-params.cpp.

const uint32_t ndn::EC_KEY_SIZES[] = {256, 384}
static

Definition at line 28 of file key-params.cpp.

constexpr in_place_t ndn::in_place {}

Definition at line 98 of file backports-optional.hpp.

const size_t ndn::MAX_NDN_PACKET_SIZE = 8800

practical limit of network layer packet size

If a packet is longer than this size, library and application MAY drop it.

Definition at line 39 of file encoding/tlv.hpp.

const size_t ndn::MAX_SIZE_OF_BLOCK_FROM_STREAM = MAX_NDN_PACKET_SIZE

Definition at line 47 of file block.cpp.

const uint32_t ndn::MIN_RSA_KEY_SIZE = 1024
static

Definition at line 26 of file key-params.cpp.

constexpr nullopt_t ndn::nullopt {0}

Definition at line 108 of file backports-optional.hpp.