All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
ndn::ndnd::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 <ndnd-forwarding-flags.hpp>

Public Member Functions

 ForwardingFlags ()
 Create a new ForwardingFlags with "active" and "childInherit" set and all other flags cleared. More...
 
 ForwardingFlags (const Block &wire)
 Create from wire encoding. More...
 
bool getActive () const
 Get the value of the "active" flag. More...
 
bool getChildInherit () const
 Get the value of the "childInherit" flag. More...
 
bool getAdvertise () const
 Get the value of the "advertise" flag. More...
 
bool getLast () const
 Get the value of the "last" flag. More...
 
bool getCapture () const
 Get the value of the "capture" flag. More...
 
bool getLocal () const
 Get the value of the "local" flag. More...
 
bool getTap () const
 Get the value of the "tap" flag. More...
 
bool getCaptureOk () const
 Get the value of the "captureOk" flag. More...
 
void setActive (bool active)
 Set the value of the "active" flag. More...
 
void setChildInherit (bool childInherit)
 Set the value of the "childInherit" flag. More...
 
void setAdvertise (bool advertise)
 Set the value of the "advertise" flag. More...
 
void setLast (bool last)
 Set the value of the "last" flag. More...
 
void setCapture (bool capture)
 Set the value of the "capture" flag. More...
 
void setLocal (bool local)
 Set the value of the "local" flag. More...
 
void setTap (bool tap)
 Set the value of the "tap" flag. More...
 
void setCaptureOk (bool captureOk)
 Set the value of the "captureOk" flag. More...
 
const Block & wireEncode () const
 
void wireDecode (const Block &block)
 

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.

Definition at line 22 of file ndnd-forwarding-flags.hpp.

Constructor & Destructor Documentation

ndn::ndnd::ForwardingFlags::ForwardingFlags ( )
inline

Create a new ForwardingFlags with "active" and "childInherit" set and all other flags cleared.

Definition at line 28 of file ndnd-forwarding-flags.hpp.

ndn::ndnd::ForwardingFlags::ForwardingFlags ( const Block &  wire)
inlineexplicit

Create from wire encoding.

Definition at line 44 of file ndnd-forwarding-flags.hpp.

Member Function Documentation

bool ndn::ndnd::ForwardingFlags::getActive ( ) const
inline

Get the value of the "active" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 53 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getAdvertise ( ) const
inline

Get the value of the "advertise" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 65 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getCapture ( ) const
inline

Get the value of the "capture" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 77 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getCaptureOk ( ) const
inline

Get the value of the "captureOk" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 95 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getChildInherit ( ) const
inline

Get the value of the "childInherit" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 59 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getLast ( ) const
inline

Get the value of the "last" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 71 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getLocal ( ) const
inline

Get the value of the "local" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 83 of file ndnd-forwarding-flags.hpp.

bool ndn::ndnd::ForwardingFlags::getTap ( ) const
inline

Get the value of the "tap" flag.

Returns
true if the flag is set, false if it is cleared.

Definition at line 89 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setActive ( bool  active)
inline

Set the value of the "active" flag.

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

Definition at line 101 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setAdvertise ( bool  advertise)
inline

Set the value of the "advertise" flag.

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

Definition at line 113 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setCapture ( bool  capture)
inline

Set the value of the "capture" flag.

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

Definition at line 125 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setCaptureOk ( bool  captureOk)
inline

Set the value of the "captureOk" flag.

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

Definition at line 143 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setChildInherit ( bool  childInherit)
inline

Set the value of the "childInherit" flag.

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

Definition at line 107 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setLast ( bool  last)
inline

Set the value of the "last" flag.

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

Definition at line 119 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setLocal ( bool  local)
inline

Set the value of the "local" flag.

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

Definition at line 131 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::setTap ( bool  tap)
inline

Set the value of the "tap" flag.

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

Definition at line 137 of file ndnd-forwarding-flags.hpp.

void ndn::ndnd::ForwardingFlags::wireDecode ( const Block &  block)
inline

Definition at line 194 of file ndnd-forwarding-flags.hpp.

const Block & ndn::ndnd::ForwardingFlags::wireEncode ( ) const
inline

Definition at line 165 of file ndnd-forwarding-flags.hpp.