proxygen: folly::FunctionScheduler::RepeatFunc Struct Reference

Public Member Functions
	RepeatFunc (Function< void()> &&cback, IntervalDistributionFunc &&intervalFn, const std::string &nameID, const std::string &intervalDistDescription, std::chrono::milliseconds delay, bool once)

	RepeatFunc (Function< void()> &&cback, NextRunTimeFunc &&nextRunTimeFn, const std::string &nameID, const std::string &intervalDistDescription, std::chrono::milliseconds delay, bool once)

std::chrono::steady_clock::time_point	getNextRunTime () const

void	setNextRunTimeStrict (std::chrono::steady_clock::time_point curTime)

void	setNextRunTimeSteady ()

void	resetNextRunTime (std::chrono::steady_clock::time_point curTime)

void	cancel ()

bool	isValid () const

Static Public Member Functions
static NextRunTimeFunc	getNextRunTimeFunc (IntervalDistributionFunc &&intervalFn)

Public Attributes
Function< void()>	cb

NextRunTimeFunc	nextRunTimeFunc

std::chrono::steady_clock::time_point	nextRunTime

std::string	name

std::chrono::milliseconds	startDelay

std::string	intervalDescr

bool	runOnce

Detailed Description

Definition at line 237 of file FunctionScheduler.h.

Constructor & Destructor Documentation

folly::FunctionScheduler::RepeatFunc::RepeatFunc	(	Function< void()> &&	cback,
		IntervalDistributionFunc &&	intervalFn,
		const std::string &	nameID,
		const std::string &	intervalDistDescription,
		std::chrono::milliseconds	delay,
		bool	once
	)

inline

Definition at line 246 of file FunctionScheduler.h.

         : RepeatFunc(
               std::move(cback),
               getNextRunTimeFunc(std::move(intervalFn)),
               nameID,
               intervalDistDescription,
               delay,
               once) {}

folly::FunctionScheduler::RepeatFunc::RepeatFunc	(	Function< void()> &&	cback,
		NextRunTimeFunc &&	nextRunTimeFn,
		const std::string &	nameID,
		const std::string &	intervalDistDescription,
		std::chrono::milliseconds	delay,
		bool	once
	)

inline

Definition at line 261 of file FunctionScheduler.h.

         : cb(std::move(cback)),
           nextRunTimeFunc(std::move(nextRunTimeFn)),
           nextRunTime(),
           name(nameID),
           startDelay(delay),
           intervalDescr(intervalDistDescription),
           runOnce(once) {}

Member Function Documentation

void folly::FunctionScheduler::RepeatFunc::cancel ( )

inline

Definition at line 297 of file FunctionScheduler.h.

Referenced by folly::FunctionScheduler::cancelFunction().

                   {
       // Simply reset cb to an empty function.
       cb = {};
     }

std::chrono::steady_clock::time_point folly::FunctionScheduler::RepeatFunc::getNextRunTime ( ) const

inline

Definition at line 285 of file FunctionScheduler.h.

                                                            {
       return nextRunTime;
     }

static NextRunTimeFunc folly::FunctionScheduler::RepeatFunc::getNextRunTimeFunc ( IntervalDistributionFunc && intervalFn )

inlinestatic

Definition at line 276 of file FunctionScheduler.h.

References folly::gen::move.

                                                {
       return [intervalFn = std::move(intervalFn)](
                  std::chrono::steady_clock::time_point /* curNextRunTime */,
                  std::chrono::steady_clock::time_point curTime) mutable {
         return curTime + intervalFn();
       };
     }

bool folly::FunctionScheduler::RepeatFunc::isValid ( ) const

inline

Definition at line 301 of file FunctionScheduler.h.

                          {
       return bool(cb);
     }

void folly::FunctionScheduler::RepeatFunc::resetNextRunTime ( std::chrono::steady_clock::time_point curTime )

inline

Definition at line 294 of file FunctionScheduler.h.

                                                                    {
       nextRunTime = curTime + startDelay;
     }

void folly::FunctionScheduler::RepeatFunc::setNextRunTimeSteady ( )

inline

Definition at line 291 of file FunctionScheduler.h.

                                 {
       nextRunTime = nextRunTimeFunc(nextRunTime, nextRunTime);
     }

void folly::FunctionScheduler::RepeatFunc::setNextRunTimeStrict ( std::chrono::steady_clock::time_point curTime )

inline

Definition at line 288 of file FunctionScheduler.h.

                                                                        {
       nextRunTime = nextRunTimeFunc(nextRunTime, curTime);
     }

Member Data Documentation

Function<void()> folly::FunctionScheduler::RepeatFunc::cb

Definition at line 238 of file FunctionScheduler.h.

std::string folly::FunctionScheduler::RepeatFunc::intervalDescr

Definition at line 243 of file FunctionScheduler.h.

std::string folly::FunctionScheduler::RepeatFunc::name

Definition at line 241 of file FunctionScheduler.h.

Referenced by folly::FunctionScheduler::cancelFunction().

std::chrono::steady_clock::time_point folly::FunctionScheduler::RepeatFunc::nextRunTime

Definition at line 240 of file FunctionScheduler.h.

NextRunTimeFunc folly::FunctionScheduler::RepeatFunc::nextRunTimeFunc

Definition at line 239 of file FunctionScheduler.h.

bool folly::FunctionScheduler::RepeatFunc::runOnce

Definition at line 244 of file FunctionScheduler.h.

std::chrono::milliseconds folly::FunctionScheduler::RepeatFunc::startDelay

Definition at line 242 of file FunctionScheduler.h.

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

proxygen/folly/folly/experimental/FunctionScheduler.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation