C++ Actor Framework  0.18
Classes | Public Member Functions | List of all members
caf::credit_controller Class Referenceabstract

Computes credit for an attached source. More...

#include <credit_controller.hpp>

Inheritance diagram for caf::credit_controller:
Inheritance graph
Collaboration diagram for caf::credit_controller:
Collaboration graph

Classes

struct  calibration
 Wraps an assignment of the controller to its source. More...
 

Public Member Functions

virtual void before_processing (downstream_msg::batch &batch)=0
 Called before processing the batch x in order to allow the controller to keep statistics on incoming batches. More...
 
virtual calibration init ()=0
 Returns an initial calibration for the path.
 
virtual calibration calibrate ()=0
 Computes a credit assignment to the source after crossing the low-threshold. More...
 

Detailed Description

Computes credit for an attached source.

Member Function Documentation

◆ before_processing()

virtual void caf::credit_controller::before_processing ( downstream_msg::batch batch)
pure virtual

Called before processing the batch x in order to allow the controller to keep statistics on incoming batches.

Implemented in caf::detail::token_based_credit_controller.

◆ calibrate()

virtual calibration caf::credit_controller::calibrate ( )
pure virtual

Computes a credit assignment to the source after crossing the low-threshold.

May assign zero credit.

Implemented in caf::detail::size_based_credit_controller, and caf::detail::token_based_credit_controller.


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