PrevUpHomeNext

Struct parameters

fd::correlating_timepieces_test_player::parameters

Synopsis

// In header: <fd/correlating_timepieces_test_player.h>



struct parameters {

  // private static functions
  template<bool = true> static scheduling_purpose default_purpose() noexcept;

  // public data members
  scheduling_purpose purpose;
  schedule_timepoint now;
  std::optional< int > nSets;
  bool suppress_contiguously_up_or_down;
  bool cap_task_execution;
  bool suspend_scheduled_actions;
  struct fd::correlating_timepieces_test_player::parameters sims;
};

Description

parameters private static functions

  1. template<bool = true> static scheduling_purpose default_purpose() noexcept;

parameters public public data members

  1. std::optional< int > nSets;

    How many cycles the player should cycle through; (if unset a default of 2 or 3 under certain conditions will be used).

  2. bool suppress_contiguously_up_or_down;

    Whether to suppress calling the launch handler for an uptime timepiece, which is contiguously up, or calling the termination handler for a halt timepiece, which is coniguously down. For testing and logging purposes it can be useful to set this flag false.

  3. struct fd::correlating_timepieces_test_player::parameters sims;

    Simulated conditions:

    • Suspended scheduled actions, e.g. due to a failure count threshold.


PrevUpHomeNext