Simple policer class. More...

#include <AftNode.h>

Inheritance diagram for AftPolicer:

Public Types
typedef std::shared_ptr < AftPolicer >	Ptr
	Pointer type for policers.

Public Member Functions
	AftPolicer (const AftPolicer &node)
	Copy constructor for a policer. More...

	AftPolicer (const uint64_t newBurstSize, const uint64_t newRate, const bool newPacketMode)
	Construct a policer. More...

const uint64_t	burstSize () const

const uint64_t	rate () const

const bool	packetMode () const

virtual const std::string	nodeType () const

virtual std::ostream &	description (std::ostream &os) const
	Append a description of the node to an output stream. More...

Public Member Functions inherited from AftNode
	AftNode (const AftNode &node)
	Copy constructor for a basic node. More...

	AftNode (const AftNodeToken newToken=AFT_NODE_TOKEN_NONE, const AftNodeToken newNext=AFT_NODE_TOKEN_NONE, const std::string newName="")
	Construct an entry for a basic node. More...

	operator const AftNodeToken () const

const AftNodeToken	nodeToken () const

const std::string	nodeName () const

const AftTypeIndex	nodeTypeIndex () const

void	setNodeNext (AftNodeToken newNext)
	Set the (optional) next node. More...

const AftNodeToken	nodeNext () const

void	setNodeParameters (const AftParameters::Ptr &newParams)
	Set the optional parameters of the node. More...

const AftParameters::Ptr	nodeParameters () const

template<class T >
std::shared_ptr< T >	nodeParameter (const std::string &name)
	Convenience parameter access template. Use this to access node parameters. More...

void	setNodeParameter (const std::string &name, const AftDataPtr &data)
	Convenience parameter setter. Use this to set node parameters. More...

virtual const bool	nodeIsContainer () const
	@ returns true if node can take entries

virtual const bool	nodeIsDelete () const
	@ returns true if node is a delete

virtual const bool	nodeIsValid (const AftValidatorPtr &validator, std::ostream &os)
	@ returns true if node is valid

virtual void	nextNodes (AftTokenVector &nextTokens)

Static Public Member Functions
static AftPolicer::Ptr	create (const uint64_t newBurstSize, const uint64_t newRate, const bool newPacketMode)
	Factory generate a policer. More...

Static Public Member Functions inherited from AftNode
template<class T >
static std::shared_ptr< T >	downcast (const AftNodePtr &node)
	Convenience downcast template. Use this instead of manual casting if required. More...

Protected Attributes
uint64_t	_burstSize
	Burst size of policer.

uint64_t	_rate
	Rate of policer.

bool	_packetMode
	True if policer is packet-oriented.

Protected Attributes inherited from AftNode
friend	AftInsert
	AftInsert accesses the setNodeName and setNodeToken methods.

friend	AftSandbox
	AftSandbox accesses the setNodeName and setNodeToken methods.

friend	AfiNodeRpc
	AfiNodeRpc accesses the setNodeName and setNodeToken methods.

AftNodeToken	_nodeToken
	Unique token value for node.

AftNodeToken	_nodeNext
	Optional value of next node.

std::string	_nodeName
	Optional name of node.

AftParameters::Ptr	_nodeParams
	Optional node parameters.

AftTypeIndex	_nodeTypeIndex
	Scalar index type for node.

Additional Inherited Members
Protected Member Functions inherited from AftNode
void	setNodeName (std::string newName)
	Set the name of the node. More...

void	setNodeToken (AftNodeToken newToken)
	Set the token value of the node. More...

void	setNodeTypeIndex (AftTypeIndex newTypeIndex)
	Set the sandbox node type index. More...

Detailed Description

Simple policer class.

Constructor & Destructor Documentation

AftPolicer::AftPolicer ( const AftPolicer & node )

inline

Copy constructor for a policer.

Parameters

[in] node AftPolicer to copy

AftPolicer::AftPolicer	(	const uint64_t	newBurstSize,
		const uint64_t	newRate,
		const bool	newPacketMode
	)

inline

Construct a policer.

Parameters

[in]	newBurstSize	Burst size of policer
[in]	newRate	Rate of policer
[in]	newPacketMode	True if policer is packet-oriented

Member Function Documentation

const uint64_t AftPolicer::burstSize ( ) const

inline

Returns: Burst size of policer

static AftPolicer::Ptr AftPolicer::create	(	const uint64_t	newBurstSize,
		const uint64_t	newRate,
		const bool	newPacketMode
	)

inlinestatic

Factory generate a policer.

Parameters

[in]	newBurstSize	Burst size of policer
[in]	newRate	Rate of policer
[in]	newPacketMode	True if policer is packet-oriented

virtual std::ostream& AftPolicer::description ( std::ostream & os ) const

inlinevirtual

Append a description of the node to an output stream.

Parameters

[in] os Reference to output stream to append description to

Returns: Reference to output stream with text description of node appended

Reimplemented from AftNode.

virtual const std::string AftPolicer::nodeType ( ) const

inlinevirtual

Returns: Printable class type of node

Reimplemented from AftNode.

const bool AftPolicer::packetMode ( ) const

inline

Returns: True if policer is packet-oriented

const uint64_t AftPolicer::rate ( ) const

inline

Returns: Rate of policer

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

AftNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation