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>

Inheritance diagram for ndn::ForwardingFlags:

Public Member Functions
	ForwardingFlags ()
	Create a new ForwardingFlags with "active" and "childInherit" set and all other flags cleared.
	ForwardingFlags (const struct ndn_ForwardingFlags &forwardingFlagsStruct)
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...

Additional Inherited Members
Public Attributes inherited from ndn_ForwardingFlags
int	active
	1 if the flag is set, 0 if cleared. More...
int	childInherit
int	advertise
int	last
int	capture
int	local
int	tap
int	captureOk

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

bool ndn::ForwardingFlags::getActive ( ) const

inline

Get the value of the "active" flag.

Returns

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

bool ndn::ForwardingFlags::getAdvertise ( ) const

inline

Get the value of the "advertise" flag.

Returns

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

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::getCaptureOk ( ) const

inline

Get the value of the "captureOk" 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.

bool ndn::ForwardingFlags::getLast ( ) const

inline

Get the value of the "last" flag.

Returns

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

bool ndn::ForwardingFlags::getLocal ( ) const

inline

Get the value of the "local" flag.

Returns

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

bool ndn::ForwardingFlags::getTap ( ) const

inline

Get the value of the "tap" flag.

Returns

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

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

inline

Set the value of the "active" flag.

Parameters

active

true to set the flag, false to clear it.

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

inline

Set the value of the "advertise" flag.

Parameters

advertise

true to set the flag, false to clear it.

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

inline

Set the value of the "capture" flag.

Parameters

capture

true to set the flag, false to clear it.

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

inline

Set the value of the "captureOk" flag.

Parameters

captureOk

true to set the flag, false to clear it.

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

inline

Set the value of the "childInherit" flag.

Parameters

childInherit

true to set the flag, false to clear it.

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

inline

Set the value of the "last" flag.

Parameters

last	true to set the flag, false to clear it.

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

inline

Set the value of the "local" flag.

Parameters

local

true to set the flag, false to clear it.

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

inline

Set the value of the "tap" flag.

Parameters

tap	true to set the flag, false to clear it.

---

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

• include/ndn-cpp/forwarding-flags.hpp
• src/forwarding-flags.cpp