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
AftInsert Class Reference

Transactional insert used for inserting sandbox state. More...

#include <AftSandbox.h>

Public Member Functions

 AftInsert (const AftSandboxPtr &sandbox)
 Constructor for insert blocks. More...
 
template<class T >
void insert (T handler)
 
AftNodeToken push (const AftNodePtr &node, AftNodeToken nodeToken, const std::string &name)
 Push node into insert block. More...
 
AftNodeToken push (const AftNodePtr &node)
 Push node into the insert block. More...
 
AftNodeToken push (const AftNodePtr &node, const std::string &name)
 Push node into the insert block. More...
 
AftNodeToken push (const AftNodePtr &node, AftNodeToken nodeToken)
 Push node into the insert block. More...
 
void push (const AftEntryPtr &entry)
 Push entry into the insert block. More...
 
void clear ()
 Clear any pushed state from block.
 
const AftNodeVectornodes () const
 
const AftEntryVectorentries () const
 

Static Public Member Functions

static AftInsertPtr create (const AftSandboxPtr &sandbox)
 Factory constructor for insert blocks. More...
 

Protected Attributes

friend AftSandbox
 AftSandbox accesses the protected vectors.
 
friend AftRemove
 AftRemove accesses the protected vectors.
 
AftSandboxPtr _sandbox
 Pointer to sandbox to use to allocate tokens.
 
AftNodeVector _nodes
 Vector of AftNode objects to insert in sandbox.
 
AftEntryVector _entries
 Vector of AftEntry objects to insert sandbox.
 
bool _sent
 True if the insert has been sent to a sandbox.
 

Detailed Description

Transactional insert used for inserting sandbox state.

Constructor & Destructor Documentation

AftInsert::AftInsert ( const AftSandboxPtr sandbox)
inline

Constructor for insert blocks.

Parameters
[in]sandboxReference to sandbox to use for insertion

Member Function Documentation

static AftInsertPtr AftInsert::create ( const AftSandboxPtr sandbox)
inlinestatic

Factory constructor for insert blocks.

Parameters
[in]sandboxReference to sandbox to use for insertion
const AftEntryVector& AftInsert::entries ( ) const
inline
Returns
Vector of AftEntry objects to insert sandbox
const AftNodeVector& AftInsert::nodes ( ) const
inline
Returns
Vector of AftNode objects to insert in sandbox
AftNodeToken AftInsert::push ( const AftNodePtr node,
AftNodeToken  nodeToken,
const std::string &  name 
)
inline

Push node into insert block.

Parameters
[in]nodeReference to node to push into insert block
[in]nodeTokenToken to use for pushed node
[in]nameName to use for node in sandbox
Returns
Allocated token value of pushed node
AftNodeToken AftInsert::push ( const AftNodePtr node)
inline

Push node into the insert block.

Parameters
[in]nodeReference to node to push into insert block
Returns
Allocated token value of pushed node
AftNodeToken AftInsert::push ( const AftNodePtr node,
const std::string &  name 
)
inline

Push node into the insert block.

Parameters
[in]nodeReference to node to push into insert block
[in]nameName to use for node in sandbox
Returns
Allocated token value of pushed node
AftNodeToken AftInsert::push ( const AftNodePtr node,
AftNodeToken  nodeToken 
)
inline

Push node into the insert block.

Parameters
[in]nodeReference to node to push into insert block
[in]nodeTokenToken to use for pushed node
Returns
Allocated token value of pushed node
void AftInsert::push ( const AftEntryPtr entry)
inline

Push entry into the insert block.

Parameters
[in]entryReference to entry to push into insert block

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