OpenSDN source code
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
DBTableWalk Class Reference

#include <db_table.h>

Collaboration diagram for DBTableWalk:
Collaboration graph
[legend]

Public Types

enum  WalkState {
  INIT = 1 , WALK_REQUESTED = 2 , WALK_IN_PROGRESS = 3 , WALK_DONE = 4 ,
  WALK_STOPPED = 5
}
 

Public Member Functions

 DBTableWalk (DBTable *table, DBTable::WalkFn walk_fn, DBTable::WalkCompleteFn walk_complete)
 
DBTable * table () const
 
DBTable::WalkFn walk_fn () const
 
DBTable::WalkCompleteFn walk_complete () const
 
bool requested () const
 
bool in_progress () const
 
bool done () const
 
bool stopped () const
 
bool walk_again () const
 
bool walk_is_active () const
 
WalkState walk_state () const
 

Private Member Functions

void set_walk_again ()
 
void reset_walk_again ()
 
void set_walk_done ()
 
void set_walk_requested ()
 
void set_in_progress ()
 
void set_walk_stopped ()
 
 DISALLOW_COPY_AND_ASSIGN (DBTableWalk)
 

Private Attributes

DBTable * table_
 
DBTable::WalkFn walk_fn_
 
DBTable::WalkCompleteFn walk_complete_
 
tbb::atomic< WalkState > walk_state_
 
tbb::atomic< bool > walk_again_
 
tbb::atomic< int > refcount_
 

Friends

class DBTableWalkMgr
 
void intrusive_ptr_add_ref (DBTableWalk *walker)
 
void intrusive_ptr_release (DBTableWalk *walker)
 

Detailed Description

Definition at line 359 of file db_table.h.

Member Enumeration Documentation

◆ WalkState

enum DBTableWalk::WalkState
Enumerator
INIT 
WALK_REQUESTED 
WALK_IN_PROGRESS 
WALK_DONE 
WALK_STOPPED 

Definition at line 361 of file db_table.h.

Constructor & Destructor Documentation

◆ DBTableWalk()

DBTableWalk::DBTableWalk ( DBTable *  table,
DBTable::WalkFn  walk_fn,
DBTable::WalkCompleteFn  walk_complete 
)
inline

Definition at line 369 of file db_table.h.

Member Function Documentation

◆ DISALLOW_COPY_AND_ASSIGN()

DBTableWalk::DISALLOW_COPY_AND_ASSIGN ( DBTableWalk  )
private

◆ done()

bool DBTableWalk::done ( ) const
inline

Definition at line 383 of file db_table.h.

◆ in_progress()

bool DBTableWalk::in_progress ( ) const
inline

Definition at line 382 of file db_table.h.

◆ requested()

bool DBTableWalk::requested ( ) const
inline

Definition at line 381 of file db_table.h.

◆ reset_walk_again()

void DBTableWalk::reset_walk_again ( )
inlineprivate

Definition at line 400 of file db_table.h.

◆ set_in_progress()

void DBTableWalk::set_in_progress ( )
inlineprivate

Definition at line 404 of file db_table.h.

◆ set_walk_again()

void DBTableWalk::set_walk_again ( )
inlineprivate

Definition at line 399 of file db_table.h.

◆ set_walk_done()

void DBTableWalk::set_walk_done ( )
inlineprivate

Definition at line 402 of file db_table.h.

◆ set_walk_requested()

void DBTableWalk::set_walk_requested ( )
inlineprivate

Definition at line 403 of file db_table.h.

◆ set_walk_stopped()

void DBTableWalk::set_walk_stopped ( )
inlineprivate

Definition at line 405 of file db_table.h.

◆ stopped()

bool DBTableWalk::stopped ( ) const
inline

Definition at line 384 of file db_table.h.

◆ table()

DBTable* DBTableWalk::table ( ) const
inline

Definition at line 377 of file db_table.h.

◆ walk_again()

bool DBTableWalk::walk_again ( ) const
inline

Definition at line 385 of file db_table.h.

◆ walk_complete()

DBTable::WalkCompleteFn DBTableWalk::walk_complete ( ) const
inline

Definition at line 379 of file db_table.h.

◆ walk_fn()

DBTable::WalkFn DBTableWalk::walk_fn ( ) const
inline

Definition at line 378 of file db_table.h.

◆ walk_is_active()

bool DBTableWalk::walk_is_active ( ) const
inline

Definition at line 386 of file db_table.h.

◆ walk_state()

WalkState DBTableWalk::walk_state ( ) const
inline

Definition at line 391 of file db_table.h.

Friends And Related Function Documentation

◆ DBTableWalkMgr

friend class DBTableWalkMgr
friend

Definition at line 394 of file db_table.h.

◆ intrusive_ptr_add_ref

void intrusive_ptr_add_ref ( DBTableWalk *  walker)
friend

Definition at line 417 of file db_table.h.

◆ intrusive_ptr_release

void intrusive_ptr_release ( DBTableWalk *  walker)
friend

Definition at line 421 of file db_table.h.

Member Data Documentation

◆ refcount_

tbb::atomic<int> DBTableWalk::refcount_
private

Definition at line 412 of file db_table.h.

◆ table_

DBTable* DBTableWalk::table_
private

Definition at line 407 of file db_table.h.

◆ walk_again_

tbb::atomic<bool> DBTableWalk::walk_again_
private

Definition at line 411 of file db_table.h.

◆ walk_complete_

DBTable::WalkCompleteFn DBTableWalk::walk_complete_
private

Definition at line 409 of file db_table.h.

◆ walk_fn_

DBTable::WalkFn DBTableWalk::walk_fn_
private

Definition at line 408 of file db_table.h.

◆ walk_state_

tbb::atomic<WalkState> DBTableWalk::walk_state_
private

Definition at line 410 of file db_table.h.

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