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

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

#include <forwarding-flags-lite.hpp>

Inheritance diagram for ndn::ForwardingFlagsLite:
ndn_ForwardingFlags

Public Member Functions

 ForwardingFlagsLite ()
 Create a ForwardingFlagsLite 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...
 
int getNfdForwardingFlags () const
 Get an integer with the bits set according to the NFD forwarding flags as used in the ControlParameters of the command interest. More...
 
void setNfdForwardingFlags (int nfdForwardingFlags)
 Set the flags according to the NFD forwarding flags as used in the ControlParameters of the command interest. More...
 

Static Public Member Functions

static ForwardingFlagsLitedownCast (ndn_ForwardingFlags &forwardingFlags)
 Downcast the reference to the ndn_ForwardingFlags struct to a ForwardingFlagsLite. More...
 
static const ForwardingFlagsLitedownCast (const ndn_ForwardingFlags &forwardingFlags)
 

Detailed Description

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

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

Member Function Documentation

static ForwardingFlagsLite& ndn::ForwardingFlagsLite::downCast ( ndn_ForwardingFlags forwardingFlags)
inlinestatic

Downcast the reference to the ndn_ForwardingFlags struct to a ForwardingFlagsLite.

Parameters
forwardingFlagsA reference to the ndn_ForwardingFlags struct.
Returns
The same reference as ForwardingFlagsLite.
bool ndn::ForwardingFlagsLite::getCapture ( ) const
inline

Get the value of the "capture" flag.

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

Get the value of the "childInherit" flag.

Returns
true if the flag is set, false if it is cleared.
int ndn::ForwardingFlagsLite::getNfdForwardingFlags ( ) const

Get an integer with the bits set according to the NFD forwarding flags as used in the ControlParameters of the command interest.

Returns
An integer with the bits set.
void ndn::ForwardingFlagsLite::setCapture ( bool  capture)
inline

Set the value of the "capture" flag.

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

Set the value of the "childInherit" flag.

Parameters
childInherittrue to set the flag, false to clear it.
void ndn::ForwardingFlagsLite::setNfdForwardingFlags ( int  nfdForwardingFlags)

Set the flags according to the NFD forwarding flags as used in the ControlParameters of the command interest.

Parameters
nfdForwardingFlagsAn integer with the bits set.

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