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

A ForwardingEntry holds an action and Name prefix and other fields for a forwarding entry. More...

#include <forwarding-entry.hpp>

Public Member Functions

 ForwardingEntry (const std::string &action, const Name &prefix, const PublisherPublicKeyDigest publisherPublicKeyDigest, int faceId, const ForwardingFlags &forwardingFlags, Milliseconds freshnessPeriod)
 
Blob wireEncode (WireFormat &wireFormat=*WireFormat::getDefaultWireFormat()) const
 
void wireDecode (const uint8_t *input, size_t inputLength, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
 
void wireDecode (const std::vector< uint8_t > &input, WireFormat &wireFormat=*WireFormat::getDefaultWireFormat())
 
void get (struct ndn_ForwardingEntry &forwardingEntryStruct) const
 Set the forwardingEntryStruct to point to the components in this forwarding entry, without copying any memory. More...
 
const std::string & getAction () const
 
NamegetPrefix ()
 
const NamegetPrefix () const
 
PublisherPublicKeyDigestgetPublisherPublicKeyDigest ()
 
const PublisherPublicKeyDigestgetPublisherPublicKeyDigest () const
 
int getFaceId () const
 
const ForwardingFlagsgetForwardingFlags () const
 
Milliseconds getFreshnessPeriod () const
 
int DEPRECATED_IN_NDN_CPP getFreshnessSeconds () const
 
void set (const struct ndn_ForwardingEntry &forwardingEntryStruct)
 Clear this forwarding entry, and set the values by copying from forwardingEntryStruct. More...
 
void setAction (const std::string &action)
 
void setFaceId (int faceId)
 
void setForwardingFlags (const ForwardingFlags &forwardingFlags)
 
void setFreshnessPeriod (Milliseconds freshnessPeriod)
 
void DEPRECATED_IN_NDN_CPP setFreshnessSeconds (int freshnessSeconds)
 

Detailed Description

A ForwardingEntry holds an action and Name prefix and other fields for a forwarding entry.

Deprecated:
This is for NDNx. Install NFD and use Face.setCommandSigningInfo with registerPrefix.

Member Function Documentation

void ndn::ForwardingEntry::get ( struct ndn_ForwardingEntry & forwardingEntryStruct  ) const

Set the forwardingEntryStruct to point to the components in this forwarding entry, without copying any memory.

WARNING: The resulting pointers in forwardingEntryStruct are invalid after a further use of this object which could reallocate memory.

Parameters
forwardingEntryStructa C ndn_ForwardingEntry struct where the prefix name components array is already allocated.
int DEPRECATED_IN_NDN_CPP ndn::ForwardingEntry::getFreshnessSeconds ( ) const
inline
Deprecated:
Use getFreshnessPeriod.
void ndn::ForwardingEntry::set ( const struct ndn_ForwardingEntry & forwardingEntryStruct  )

Clear this forwarding entry, and set the values by copying from forwardingEntryStruct.

Parameters
forwardingEntryStructa C ndn_ForwardingEntry struct.
void DEPRECATED_IN_NDN_CPP ndn::ForwardingEntry::setFreshnessSeconds ( int  freshnessSeconds)
inline
Deprecated:
Use setFreshnessPeriod.

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