An InterestLite holds a NameLite and other fields for an interest.
More...
#include <interest-lite.hpp>
|
class | Tlv0_1_1WireFormatLite |
|
An InterestLite holds a NameLite and other fields for an interest.
Create an InterestLite with the pre-allocated nameComponents and excludeEntries, and defaults for all the values.
- Parameters
-
nameComponents | The pre-allocated array of ndn_NameComponent. Instead of an array of NameLite::Component, this is an array of the underlying ndn_NameComponent struct so that it doesn't run the default constructor unnecessarily. |
maxNameComponents | The number of elements in the allocated nameComponents array. |
excludeEntries | The pre-allocated array of ndn_ExcludeEntry. Instead of an array of ExcludeLite::Entry, this is an array of the underlying ndn_ExcludeEntry struct so that it doesn't run the default constructor unnecessarily. |
maxExcludeEntries | The number of elements in the allocated excludeEntries array. |
keyNameComponents | The pre-allocated array of ndn_NameComponent for the keyLocator. Instead of an array of NameLite::Component, this is an array of the underlying ndn_NameComponent struct so that it doesn't run the default constructor unnecessarily. |
maxKeyNameComponents | The number of elements in the allocated keyNameComponents array. |
bool ndn::InterestLite::getMustBeFresh |
( |
| ) |
const |
Return true if the content must be fresh.
The default is true.
- Returns
- true if must be fresh, otherwise false.
ndn_Error ndn::InterestLite::set |
( |
const InterestLite & |
other | ) |
|
Set this interest object to have the values from the other interest.
- Parameters
-
- Returns
- 0 for success, or an error code if there is not enough room in this object's name components array or exclude entries array.
InterestLite& ndn::InterestLite::setChildSelector |
( |
int |
childSelector | ) |
|
|
inline |
Set the child selector.
- Parameters
-
childSelector | The child selector. If not specified, set to -1. |
- Returns
- This InterestLite so that you can chain calls to update values.
Set the interest lifetime.
- Parameters
-
interestLifetimeMilliseconds | The interest lifetime in milliseconds. If not specified, set to -1. |
- Returns
- This InterestLite so that you can chain calls to update values.
Set the link wire encoding.
- Parameters
-
linkWireEncoding | The encoding value. This does not copy the bytes of the encoding. |
- Returns
- This InterestLite so that you can chain calls to update values.
InterestLite& ndn::InterestLite::setMaxSuffixComponents |
( |
int |
maxSuffixComponents | ) |
|
|
inline |
Set the max suffix components count.
- Parameters
-
maxSuffixComponents | The max suffix components count. If not specified, set to -1. |
- Returns
- This InterestLite so that you can chain calls to update values.
InterestLite& ndn::InterestLite::setMinSuffixComponents |
( |
int |
minSuffixComponents | ) |
|
|
inline |
Set the min suffix components count.
- Parameters
-
minSuffixComponents | The min suffix components count. If not specified, set to -1. |
- Returns
- This InterestLite so that you can chain calls to update values.
InterestLite & ndn::InterestLite::setMustBeFresh |
( |
bool |
mustBeFresh | ) |
|
Set the MustBeFresh flag.
- Parameters
-
mustBeFresh | True if the content must be fresh, otherwise false. If you do not set this flag, the default value is true. |
- Returns
- This InterestLite so that you can chain calls to update values.
ndn_Error ndn::InterestLite::setName |
( |
const NameLite & |
name | ) |
|
|
inline |
Set this interest's name to have the values from the given name.
- Parameters
-
name | The name to get values from. |
- Returns
- 0 for success, or an error code if there is not enough room in this object's name components array.
Set the interest nonce.
- Parameters
-
nonce | The nonce value. This does not copy the bytes of the nonce. |
- Returns
- This InterestLite so that you can chain calls to update values.
InterestLite& ndn::InterestLite::setSelectedDelegationIndex |
( |
int |
selectedDelegationIndex | ) |
|
|
inline |
Set the selected delegation index.
- Parameters
-
selectedDelegationIndex | The selected delegation index. If not specified, set to -1. |
- Returns
- This InterestLite so that you can chain calls to update values.
The documentation for this class was generated from the following files: