A prefix announcement object that represents an application's intent of registering a prefix toward itself. More...
#include <ndn-cxx/prefix-announcement.hpp>
Classes | |
class | Error |
Public Member Functions | |
PrefixAnnouncement () | |
Construct an empty prefix announcement. More... | |
PrefixAnnouncement (Data data) | |
Decode a prefix announcement from Data. More... | |
const Name & | getAnnouncedName () const |
Return announced name. More... | |
const optional< Data > & | getData () const |
Get the Data representing the prefix announcement, if available. More... | |
time::milliseconds | getExpiration () const |
Return relative expiration period. More... | |
optional< security::ValidityPeriod > | getValidityPeriod () const |
Return absolute validity period. More... | |
PrefixAnnouncement & | setAnnouncedName (Name name) |
Set announced name. More... | |
PrefixAnnouncement & | setExpiration (time::milliseconds expiration) |
Set relative expiration period. More... | |
PrefixAnnouncement & | setValidityPeriod (optional< security::ValidityPeriod > validity) |
Set absolute validity period. More... | |
const Data & | toData (KeyChain &keyChain, const ndn::security::SigningInfo &si=security::SigningInfo(), optional< uint64_t > version=nullopt) const |
Create a Data packet representing the prefix announcement, if it does not exist. More... | |
Static Public Member Functions | |
static const name::Component & | getKeywordComponent () |
Returns the well-known keyword name component used for prefix announcements (32=PA ) More... | |
A prefix announcement object that represents an application's intent of registering a prefix toward itself.
Definition at line 36 of file prefix-announcement.hpp.
|
default |
Construct an empty prefix announcement.
|
explicit |
Decode a prefix announcement from Data.
tlv::Error | the Data is not a prefix announcement. |
Definition at line 32 of file prefix-announcement.cpp.
|
inline |
Return announced name.
Definition at line 82 of file prefix-announcement.hpp.
|
inline |
Get the Data representing the prefix announcement, if available.
Definition at line 62 of file prefix-announcement.hpp.
|
inline |
Return relative expiration period.
Definition at line 96 of file prefix-announcement.hpp.
|
static |
Returns the well-known keyword name component used for prefix announcements (32=PA
)
Definition at line 123 of file prefix-announcement.cpp.
|
inline |
Return absolute validity period.
Definition at line 111 of file prefix-announcement.hpp.
PrefixAnnouncement & ndn::PrefixAnnouncement::setAnnouncedName | ( | Name | name | ) |
Set announced name.
Definition at line 96 of file prefix-announcement.cpp.
PrefixAnnouncement & ndn::PrefixAnnouncement::setExpiration | ( | time::milliseconds | expiration | ) |
Set relative expiration period.
std::invalid_argument | expiration period is negative. |
Definition at line 104 of file prefix-announcement.cpp.
PrefixAnnouncement & ndn::PrefixAnnouncement::setValidityPeriod | ( | optional< security::ValidityPeriod > | validity | ) |
Set absolute validity period.
Definition at line 115 of file prefix-announcement.cpp.
const Data & ndn::PrefixAnnouncement::toData | ( | KeyChain & | keyChain, |
const ndn::security::SigningInfo & | si = security::SigningInfo() , |
||
optional< uint64_t > | version = nullopt |
||
) | const |
Create a Data packet representing the prefix announcement, if it does not exist.
keyChain | KeyChain to sign the Data. |
si | signing parameters. |
version | version number in Data name; if nullopt, use current Unix timestamp (in milliseconds) as the version number. |
Definition at line 70 of file prefix-announcement.cpp.