Static Public Member Functions | List of all members
ndn::TlvWireFormat Class Reference

A TlvWireFormat extends WireFormat to override its virtual methods to implement encoding and decoding using the preferred implementation of NDN-TLV. More...

#include <tlv-wire-format.hpp>

Inheritance diagram for ndn::TlvWireFormat:
ndn::Tlv0_1_1WireFormat ndn::WireFormat

Static Public Member Functions

static TlvWireFormat * get ()
 Get a singleton instance of a TlvWireFormat. More...
 
- Static Public Member Functions inherited from ndn::Tlv0_1_1WireFormat
static Tlv0_1_1WireFormat * get ()
 Get a singleton instance of a Tlv0_1_1WireFormat. More...
 
- Static Public Member Functions inherited from ndn::WireFormat
static void setDefaultWireFormat (WireFormat *wireFormat)
 Set the static default WireFormat used by default encoding and decoding methods. More...
 
static WireFormat * getDefaultWireFormat ()
 Return the default WireFormat used by default encoding and decoding methods which was set with setDefaultWireFormat. More...
 

Additional Inherited Members

- Public Member Functions inherited from ndn::Tlv0_1_1WireFormat
virtual Blob encodeName (const Name &name)
 Encode name in NDN-TLV and return the encoding. More...
 
virtual void decodeName (Name &name, const uint8_t *input, size_t inputLength)
 Decode input as a name in NDN-TLV and set the fields of the Name object. More...
 
virtual Blob encodeInterest (const Interest &interest, size_t *signedPortionBeginOffset, size_t *signedPortionEndOffset)
 Encode interest in NDN-TLV and return the encoding. More...
 
virtual void decodeInterest (Interest &interest, const uint8_t *input, size_t inputLength, size_t *signedPortionBeginOffset, size_t *signedPortionEndOffset)
 Decode input as an interest in NDN-TLV and set the fields of the interest object. More...
 
virtual Blob encodeData (const Data &data, size_t *signedPortionBeginOffset, size_t *signedPortionEndOffset)
 Encode data with NDN-TLV and return the encoding. More...
 
virtual void decodeData (Data &data, const uint8_t *input, size_t inputLength, size_t *signedPortionBeginOffset, size_t *signedPortionEndOffset)
 Decode input as a data packet in NDN-TLV and set the fields in the data object. More...
 
virtual Blob encodeControlParameters (const ControlParameters &controlParameters)
 Encode controlParameters as NDN-TLV and return the encoding. More...
 
virtual void decodeControlParameters (ControlParameters &controlParameters, const uint8_t *input, size_t inputLength)
 Decode input as an NDN-TLV ControlParameters and set the fields of the controlParameters object. More...
 
virtual Blob encodeControlResponse (const ControlResponse &controlResponse)
 Encode controlResponse as NDN-TLV and return the encoding. More...
 
virtual void decodeControlResponse (ControlResponse &controlResponse, const uint8_t *input, size_t inputLength)
 Decode input as an NDN-TLV ControlResponse and set the fields of the controlResponse object. More...
 
virtual Blob encodeSignatureInfo (const Signature &signature)
 Encode signature as an NDN-TLV SignatureInfo and return the encoding. More...
 
virtual Blob encodeSignatureValue (const Signature &signature)
 Encode the signatureValue in the Signature object as an NDN-TLV SignatureValue (the signature bits) and return the encoding. More...
 
virtual ptr_lib::shared_ptr< Signature > decodeSignatureInfoAndValue (const uint8_t *signatureInfo, size_t signatureInfoLength, const uint8_t *signatureValue, size_t signatureValueLength)
 Decode signatureInfo as a signature info and signatureValue as the related SignatureValue, and return a new object which is a subclass of Signature. More...
 
virtual Blob encodeDelegationSet (const DelegationSet &delegationSet)
 Encode delegationSet as a sequence of NDN-TLV Delegation, and return the encoding. More...
 
virtual void decodeDelegationSet (DelegationSet &delegationSet, const uint8_t *input, size_t inputLength)
 Decode input as a sequence of NDN-TLV Delegation and set the fields of the delegationSet object. More...
 
virtual Blob encodeEncryptedContent (const EncryptedContent &encryptedContent)
 Encode encryptedContent as NDN-TLV and return the encoding. More...
 
virtual void decodeEncryptedContent (EncryptedContent &encryptedContent, const uint8_t *input, size_t inputLength)
 Decode input as an NDN-TLV EncryptedContent and set the fields of the encryptedContent object. More...
 
- Public Member Functions inherited from ndn::WireFormat
Blob encodeInterest (const Interest &interest)
 Encode interest and return the encoding. More...
 
void decodeInterest (Interest &interest, const uint8_t *input, size_t inputLength)
 
Blob encodeData (const Data &data)
 Encode data and return the encoding. More...
 
void decodeData (Data &data, const uint8_t *input, size_t inputLength)
 
virtual ptr_lib::shared_ptr< Signature > decodeSignatureInfoAndValue (const Blob &signatureInfo, const Blob &signatureValue)
 Decode signatureInfo as a signature info and signatureValue as the related SignatureValue, and return a new object which is a subclass of Signature. More...
 

Detailed Description

A TlvWireFormat extends WireFormat to override its virtual methods to implement encoding and decoding using the preferred implementation of NDN-TLV.

Member Function Documentation

static TlvWireFormat* ndn::TlvWireFormat::get ( )
inlinestatic

Get a singleton instance of a TlvWireFormat.

Assuming that the default wire format was set with WireFormat::setDefaultWireFormat(TlvWireFormat::get()), you can check if this is the default wire encoding with if (WireFormat::getDefaultWireFormat() == TlvWireFormat::get()).

Returns
A pointer to the singleton instance.

The documentation for this class was generated from the following files: