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

A ForwardingFlags object holds the flags which specify how the forwarding daemon should forward an interest for a registered prefix. More...

#include <forwarding-flags.hpp>

Public Member Functions

 ForwardingFlags ()
 Create a new ForwardingFlags with "childInherit" set and all other flags cleared.
 
bool getChildInherit () const
 Get the value of the "childInherit" flag. More...
 
bool getCapture () const
 Get the value of the "capture" flag. More...
 
void setChildInherit (bool childInherit)
 Set the value of the "childInherit" flag. More...
 
void setCapture (bool capture)
 Set the value of the "capture" flag. More...
 
void get (ForwardingFlagsLite &forwardingFlagsLite) const
 Set forwardingFlagsLite to have the values in this meta info object. More...
 
void set (const ForwardingFlagsLite &forwardingFlagsLite)
 Set the values in this ForwardingFlags by copying from forwardingFlagsLite. More...
 

Detailed Description

A ForwardingFlags object holds the flags which specify how the forwarding daemon should forward an interest for a registered prefix.

We use a separate ForwardingFlags object to retain future compatibility if the daemon forwarding bits are changed, amended or deprecated.

Member Function Documentation

void ndn::ForwardingFlags::get ( ForwardingFlagsLite forwardingFlagsLite) const
inline

Set forwardingFlagsLite to have the values in this meta info object.

Parameters
forwardingFlagsLiteThe ForwardingFlagsLite object which receives the values.
bool ndn::ForwardingFlags::getCapture ( ) const
inline

Get the value of the "capture" flag.

Returns
true if the flag is set, false if it is cleared.
bool ndn::ForwardingFlags::getChildInherit ( ) const
inline

Get the value of the "childInherit" flag.

Returns
true if the flag is set, false if it is cleared.
void ndn::ForwardingFlags::set ( const ForwardingFlagsLite forwardingFlagsLite)
inline

Set the values in this ForwardingFlags by copying from forwardingFlagsLite.

Parameters
forwardingFlagsLiteA ForwardingFlagsLite object.
void ndn::ForwardingFlags::setCapture ( bool  capture)
inline

Set the value of the "capture" flag.

Parameters
capturetrue to set the flag, false to clear it.
void ndn::ForwardingFlags::setChildInherit ( bool  childInherit)
inline

Set the value of the "childInherit" flag.

Parameters
childInherittrue to set the flag, false to clear it.

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