AFI
Advanced Forwarding Interface
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
AftTokenTable Class Reference

Master class for managing token allocations. More...

#include <AftTokenTable.h>

Public Member Functions

AftNodeToken tokenCount () const
 
void setTokenCount (AftNodeToken newTokenCount)
 Set the value of the token count. Only used at initialization! More...
 
AftNodeToken nextToken ()
 
void releaseToken ()
 Releases a token back to the table.
 
void raiseToken (AftNodeToken newTokenCount)
 Raises the current token count above the supplied value.
 
void insert (AftNodeToken nodeToken, std::string nodeType)
 
void remove (AftNodeToken nodeToken)
 
const bool find (AftNodeToken nodeToken, AftTokenEntryPtr &tokenEntry)
 
const bool isValid (AftNodeToken nodeToken)
 
const bool isOfType (AftNodeToken nodeToken, std::string nodeType)
 

Static Public Member Functions

static std::shared_ptr
< AftTokenTable
create ()
 Factory convenience creator for shared_ptr to decap table.
 

Protected Attributes

AftNodeToken _tokenCount
 Upper bound of token allocation.
 
AftTokenTableMap _tokens
 Underlying map used to hold token allocation.
 

Detailed Description

Master class for managing token allocations.

Member Function Documentation

AftNodeToken AftTokenTable::nextToken ( )
inline
Returns
Next valid token in the table
void AftTokenTable::setTokenCount ( AftNodeToken  newTokenCount)
inline

Set the value of the token count. Only used at initialization!

Parameters
[in]newTokenCountNew value for the upper bound of token allocation
AftNodeToken AftTokenTable::tokenCount ( ) const
inline
Returns
Upper bound of token values allocated

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