rippled
Loading...
Searching...
No Matches
Public Member Functions | List of all members
xrpl::Workers::Callback Struct Referenceabstract

Called to perform tasks as needed. More...

#include <Workers.h>

Inheritance diagram for xrpl::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.
 

Detailed Description

Called to perform tasks as needed.

Definition at line 65 of file Workers.h.

Constructor & Destructor Documentation

◆ ~Callback()

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

◆ Callback() [1/2]

xrpl::Workers::Callback::Callback ( )
default

◆ Callback() [2/2]

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

Member Function Documentation

◆ operator=()

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

◆ processTask()

virtual void xrpl::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 xrpl::JobQueue, and xrpl::Workers_test::TestCallback.