Toolbox snapshot
The Reactive C++ Toolbox
Loading...
Searching...
No Matches
Public Member Functions | List of all members
toolbox::io::ReactorRunner Class Reference

#include <toolbox/io/Runner.hpp>

Public Member Functions

 ReactorRunner (Reactor &r, long busy_cycles, ThreadConfig config)
 
 ReactorRunner (Reactor &r, long busy_cycles, ThreadConfig config, MetricCallbackFunction metric_cb)
 
 ReactorRunner (Reactor &r, long busy_cycles, ThreadConfig config, MetricCallbackFunction metric_cb, LoopCallbackFunction loop_cb)
 
 ~ReactorRunner ()
 
 ReactorRunner (const ReactorRunner &)=delete
 
ReactorRunneroperator= (const ReactorRunner &)=delete
 
 ReactorRunner (ReactorRunner &&)=delete
 
ReactorRunneroperator= (ReactorRunner &&)=delete
 

Detailed Description

Definition at line 39 of file Runner.hpp.

Constructor & Destructor Documentation

◆ ReactorRunner() [1/5]

toolbox::io::ReactorRunner::ReactorRunner ( Reactor r,
long  busy_cycles,
ThreadConfig  config 
)

Constructs a ReactorRunner instance.

When work is processed by the Reactor during a call to Reactor::poll, the next 'n' calls to Reactor::poll, where 'n' is busy_cycles, will not cause the thread to block or yield if no further work is available. This feature can be useful for keeping the reactor warm and responsive for short periods of time immediately after work is processed.

Parameters
rThe reactor.
busy_cyclesThe number of busy cycles after doing work.
configThe thread configuration.

Definition at line 110 of file Runner.cpp.

◆ ReactorRunner() [2/5]

toolbox::io::ReactorRunner::ReactorRunner ( Reactor r,
long  busy_cycles,
ThreadConfig  config,
MetricCallbackFunction  metric_cb 
)

Constructs a ReactorRunner instance.

When work is processed by the Reactor during a call to Reactor::poll, the next 'n' calls to Reactor::poll, where 'n' is busy_cycles, will not cause the thread to block or yield if no further work is available. This feature can be useful for keeping the reactor warm and responsive for short periods of time immediately after work is processed.

Parameters
rThe reactor.
busy_cyclesThe number of busy cycles after doing work.
configThe thread configuration.
metric_cbMetric callback function.

Definition at line 116 of file Runner.cpp.

◆ ReactorRunner() [3/5]

toolbox::io::ReactorRunner::ReactorRunner ( Reactor r,
long  busy_cycles,
ThreadConfig  config,
MetricCallbackFunction  metric_cb,
LoopCallbackFunction  loop_cb 
)

Constructs a ReactorRunner instance.

When work is processed by the Reactor during a call to Reactor::poll, the next 'n' calls to Reactor::poll, where 'n' is busy_cycles, will not cause the thread to block or yield if no further work is available. This feature can be useful for keeping the reactor warm and responsive for short periods of time immediately after work is processed.

Parameters
rThe reactor.
busy_cyclesThe number of busy cycles after doing work.
configThe thread configuration.
metric_cbMetric callback function.
loop_cbLoop callback function.

Definition at line 122 of file Runner.cpp.

◆ ~ReactorRunner()

toolbox::io::ReactorRunner::~ReactorRunner ( )

Definition at line 130 of file Runner.cpp.

◆ ReactorRunner() [4/5]

toolbox::io::ReactorRunner::ReactorRunner ( const ReactorRunner )
delete

◆ ReactorRunner() [5/5]

toolbox::io::ReactorRunner::ReactorRunner ( ReactorRunner &&  )
delete

Member Function Documentation

◆ operator=() [1/2]

ReactorRunner & toolbox::io::ReactorRunner::operator= ( const ReactorRunner )
delete

◆ operator=() [2/2]

ReactorRunner & toolbox::io::ReactorRunner::operator= ( ReactorRunner &&  )
delete

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