rippled
Public Member Functions | List of all members
ripple::Workers::Callback Struct Referenceabstract

Called to perform tasks as needed. More...

Inheritance diagram for ripple::Workers::Callback:
Inheritance graph
[legend]

Public Member Functions

virtual ~Callback ()=default
 
 Callback ()=default
 
 Callback (Callback const &)=delete
 
Callbackoperator= (Callback const &)=delete
 
virtual void processTask (int instance)=0
 Perform a task. More...
 

Detailed Description

Called to perform tasks as needed.

Definition at line 83 of file Workers.h.

Constructor & Destructor Documentation

◆ ~Callback()

virtual ripple::Workers::Callback::~Callback ( )
virtualdefault

◆ Callback() [1/2]

ripple::Workers::Callback::Callback ( )
default

◆ Callback() [2/2]

ripple::Workers::Callback::Callback ( Callback const &  )
delete

Member Function Documentation

◆ operator=()

Callback& ripple::Workers::Callback::operator= ( Callback const &  )
delete

◆ processTask()

virtual void ripple::Workers::Callback::processTask ( int  instance)
pure virtual

Perform a task.

The call is made on a thread owned by Workers. It is important that you only process one task from inside your callback. Each call to addTask will result in exactly one call to processTask.

Parameters
instanceThe worker thread instance.
See also
Workers::addTask

Implemented in ripple::JobQueue, ripple::Workers_test::TestCallback, and ripple::NodeStore::TaskQueue.