Trait/Object

zio

Schedule

Related Docs: object Schedule | package zio

Permalink

trait Schedule[-Env, -In, +Out] extends Serializable

A Schedule[Env, In, Out] defines a recurring schedule, which consumes values of type In, and which returns values of type Out.

Schedules are defined as a possibly infinite set of intervals spread out over time. Each interval defines a window in which recurrence is possible.

When schedules are used to repeat or retry effects, the starting boundary of each interval produced by a schedule is used as the moment when the effect will be executed again.

Schedules compose in the following primary ways:

* Union. This performs the union of the intervals of two schedules. * Intersection. This performs the intersection of the intervals of two schedules. * Sequence. This concatenates the intervals of one schedule onto another.

In addition, schedule inputs and outputs can be transformed, filtered (to terminate a schedule early in response to some input or output), and so forth.

A variety of other operators exist for transforming and combining schedules, and the companion object for Schedule contains all common types of schedules, both for performing retrying, as well as performing repetition.

Self Type
Schedule[Env, In, Out]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Schedule
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type State

    Permalink

Abstract Value Members

  1. abstract def initial: State

    Permalink
  2. abstract def step(now: OffsetDateTime, in: In, state: State)(implicit trace: Trace): ZIO[Env, Nothing, (State, Out, Decision)]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &&[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    Returns a new schedule that performs a geometric intersection on the intervals defined by both schedules.

  4. def ***[Env1 <: Env, In2, Out2](that: Schedule[Env1, In2, Out2]): WithState[(State, State), Env1, (In, In2), (Out, Out2)]

    Permalink

    Returns a new schedule that has both the inputs and outputs of this and the specified schedule.

  5. def *>[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State), Env1, In1, Out2]

    Permalink

    The same as &&, but ignores the left output.

  6. def ++[Env1 <: Env, In1 <: In, Out2 >: Out](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State, Boolean), Env1, In1, Out2]

    Permalink

    A symbolic alias for andThen.

  7. def +++[Env1 <: Env, In2, Out2](that: Schedule[Env1, In2, Out2]): WithState[(State, State), Env1, Either[In, In2], Either[Out, Out2]]

    Permalink

    Returns a new schedule that allows choosing between feeding inputs to this schedule, or feeding inputs to the specified schedule.

  8. def <*[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State), Env1, In1, Out]

    Permalink

    The same as &&, but ignores the right output.

  9. def <*>[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    An operator alias for zip.

  10. def <<<[Env1 <: Env, In2](that: Schedule[Env1, In2, In]): WithState[(State, State), Env1, In2, Out]

    Permalink

    A backwards version of >>>.

  11. def <||>[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2]): WithState[(State, State, Boolean), Env1, In1, Either[Out, Out2]]

    Permalink

    Operator alias for andThenEither.

  12. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def >>>[Env1 <: Env, Out2](that: Schedule[Env1, Out, Out2]): WithState[(State, State), Env1, In, Out2]

    Permalink

    Returns the composition of this schedule and the specified schedule, by piping the output of this one into the input of the other.

    Returns the composition of this schedule and the specified schedule, by piping the output of this one into the input of the other. Effects described by this schedule will always be executed before the effects described by the second schedule.

  14. def addDelay(f: (Out) ⇒ zio.Duration)(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule with the given delay added to every interval defined by this schedule.

  15. def addDelayZIO[Env1 <: Env](f: (Out) ⇒ URIO[Env1, zio.Duration])(implicit trace: Trace): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule with the given effectfully computed delay added to every interval defined by this schedule.

  16. def andThen[Env1 <: Env, In1 <: In, Out2 >: Out](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State, Boolean), Env1, In1, Out2]

    Permalink

    The same as andThenEither, but merges the output.

  17. def andThenEither[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2]): WithState[(State, State, Boolean), Env1, In1, Either[Out, Out2]]

    Permalink

    Returns a new schedule that first executes this schedule to completion, and then executes the specified schedule to completion.

  18. def as[Out2](out2: ⇒ Out2)(implicit trace: Trace): WithState[State, Env, In, Out2]

    Permalink

    Returns a new schedule that maps this schedule to a constant output.

  19. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  20. def check[In1 <: In](test: (In1, Out) ⇒ Boolean)(implicit trace: Trace): WithState[State, Env, In1, Out]

    Permalink

    Returns a new schedule that passes each input and output of this schedule to the specified function, and then determines whether or not to continue based on the return value of the function.

  21. def checkZIO[Env1 <: Env, In1 <: In](test: (In1, Out) ⇒ URIO[Env1, Boolean]): WithState[State, Env1, In1, Out]

    Permalink

    Returns a new schedule that passes each input and output of this schedule to the specified function, and then determines whether or not to continue based on the return value of the function.

  22. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def collectAll[Out1 >: Out](implicit trace: Trace): WithState[(State, Chunk[Out1]), Env, In, Chunk[Out1]]

    Permalink

    Returns a new schedule that collects the outputs of this one into a chunk.

  24. def collectUntil[Out1 >: Out](f: (Out) ⇒ Boolean)(implicit trace: Trace): WithState[(State, Chunk[Out1]), Env, In, Chunk[Out1]]

    Permalink

    Returns a new schedule that collects the outputs of this one into a list until the condition f fails.

  25. def collectUntilZIO[Env1 <: Env, Out1 >: Out](f: (Out) ⇒ URIO[Env1, Boolean])(implicit trace: Trace): WithState[(State, Chunk[Out1]), Env1, In, Chunk[Out1]]

    Permalink

    Returns a new schedule that collects the outputs of this one into a list until the effectual condition f fails.

  26. def collectWhile[Out1 >: Out](f: (Out) ⇒ Boolean)(implicit trace: Trace): WithState[(State, Chunk[Out1]), Env, In, Chunk[Out1]]

    Permalink

    Returns a new schedule that collects the outputs of this one into a list as long as the condition f holds.

  27. def collectWhileZIO[Env1 <: Env, Out1 >: Out](f: (Out) ⇒ URIO[Env1, Boolean])(implicit trace: Trace): WithState[(State, Chunk[Out1]), Env1, In, Chunk[Out1]]

    Permalink

    Returns a new schedule that collects the outputs of this one into a list as long as the effectual condition f holds.

  28. def compose[Env1 <: Env, In2](that: Schedule[Env1, In2, In]): WithState[(State, State), Env1, In2, Out]

    Permalink

    A named alias for <<<.

  29. def contramap[Env1 <: Env, In2](f: (In2) ⇒ In)(implicit trace: Trace): WithState[State, Env, In2, Out]

    Permalink

    Returns a new schedule that deals with a narrower class of inputs than this schedule.

  30. def contramapZIO[Env1 <: Env, In2](f: (In2) ⇒ URIO[Env1, In]): WithState[State, Env1, In2, Out]

    Permalink

    Returns a new schedule that deals with a narrower class of inputs than this schedule.

  31. def delayed(f: (zio.Duration) ⇒ zio.Duration)(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule with the specified effectfully computed delay added before the start of each interval produced by this schedule.

  32. def delayedZIO[Env1 <: Env](f: (zio.Duration) ⇒ URIO[Env1, zio.Duration]): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule with the specified effectfully computed delay added before the start of each interval produced by this schedule.

  33. def delays: WithState[State, Env, In, zio.Duration]

    Permalink

    Returns a new schedule that outputs the delay between each occurence.

  34. def dimap[In2, Out2](f: (In2) ⇒ In, g: (Out) ⇒ Out2)(implicit trace: Trace): WithState[State, Env, In2, Out2]

    Permalink

    Returns a new schedule that contramaps the input and maps the output.

  35. def dimapZIO[Env1 <: Env, In2, Out2](f: (In2) ⇒ URIO[Env1, In], g: (Out) ⇒ URIO[Env1, Out2]): WithState[State, Env1, In2, Out2]

    Permalink

    Returns a new schedule that contramaps the input and maps the output.

  36. def driver(implicit trace: Trace): UIO[Driver[State, Env, In, Out]]

    Permalink

    Returns a driver that can be used to step the schedule, appropriately handling sleeping.

  37. def either[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2]): WithState[(State, State), Env1, In1, (Out, Out2)]

    Permalink

    A named alias for ||.

  38. def eitherWith[Env1 <: Env, In1 <: In, Out2, Out3](that: Schedule[Env1, In1, Out2])(f: (Out, Out2) ⇒ Out3)(implicit trace: Trace): WithState[(State, State), Env1, In1, Out3]

    Permalink

    The same as either followed by map.

  39. def ensuring(finalizer: UIO[Any]): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that will run the specified finalizer as soon as the schedule is complete.

    Returns a new schedule that will run the specified finalizer as soon as the schedule is complete. Note that unlike ZIO#ensuring, this method does not guarantee the finalizer will be run. The Schedule may not initialize or the driver of the schedule may not run to completion. However, if the Schedule ever decides not to continue, then the finalizer will be run.

  40. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  42. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. def first[X]: WithState[(State, Unit), Env, (In, X), (Out, X)]

    Permalink

    Returns a new schedule that packs the input and output of this schedule into the first element of a tuple.

    Returns a new schedule that packs the input and output of this schedule into the first element of a tuple. This allows carrying information through this schedule.

  44. def fold[Z](z: Z)(f: (Z, Out) ⇒ Z)(implicit trace: Trace): WithState[(State, Z), Env, In, Z]

    Permalink

    Returns a new schedule that folds over the outputs of this one.

  45. def foldZIO[Env1 <: Env, Z](z: Z)(f: (Z, Out) ⇒ URIO[Env1, Z]): WithState[(State, Z), Env1, In, Z]

    Permalink

    Returns a new schedule that effectfully folds over the outputs of this one.

  46. def forever: WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that loops this one continuously, resetting the state when this schedule is done.

  47. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  48. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  49. def intersectWith[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(f: (Intervals, Intervals) ⇒ Intervals)(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    Returns a new schedule that combines this schedule with the specified schedule, continuing as long as both schedules want to continue and merging the next intervals according to the specified merge function.

  50. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  51. def jittered(min: Double, max: Double)(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that randomly modifies the size of the intervals of this schedule.

    Returns a new schedule that randomly modifies the size of the intervals of this schedule.

    The new interval size is between min * old interval size and max * old interval size.

    [Research](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) shows that jittered(0.0, 1.0) is a suitable range for a retrying schedule.

  52. def jittered(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that randomly modifies the size of the intervals of this schedule.

  53. def left[X]: WithState[(State, Unit), Env, Either[In, X], Either[Out, X]]

    Permalink

    Returns a new schedule that makes this schedule available on the Left side of an Either input, allowing propagating some type X through this channel on demand.

  54. def map[Out2](f: (Out) ⇒ Out2)(implicit trace: Trace): WithState[State, Env, In, Out2]

    Permalink

    Returns a new schedule that maps the output of this schedule through the specified function.

  55. def mapZIO[Env1 <: Env, Out2](f: (Out) ⇒ URIO[Env1, Out2]): WithState[State, Env1, In, Out2]

    Permalink

    Returns a new schedule that maps the output of this schedule through the specified effectful function.

  56. def modifyDelay(f: (Out, zio.Duration) ⇒ zio.Duration): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that modifies the delay using the specified function.

  57. def modifyDelayZIO[Env1 <: Env](f: (Out, zio.Duration) ⇒ URIO[Env1, zio.Duration]): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule that modifies the delay using the specified effectual function.

  58. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  59. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  60. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  61. def onDecision[Env1 <: Env](f: (State, Out, Decision) ⇒ URIO[Env1, Any]): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule that applies the current one but runs the specified effect for every decision of this schedule.

    Returns a new schedule that applies the current one but runs the specified effect for every decision of this schedule. This can be used to create schedules that log failures, decisions, or computed values.

  62. def passthrough[In1 <: In](implicit trace: Trace): WithState[State, Env, In1, In1]

    Permalink

    Returns a new schedule that passes through the inputs of this schedule.

  63. def provideEnvironment(env: ZEnvironment[Env]): WithState[State, Any, In, Out]

    Permalink

    Returns a new schedule with its environment provided to it, so the resulting schedule does not require any environment.

  64. def provideSomeEnvironment[Env2](f: (ZEnvironment[Env2]) ⇒ ZEnvironment[Env]): WithState[State, Env2, In, Out]

    Permalink

    Transforms the environment being provided to this schedule with the specified function.

  65. def reconsider[Out2](f: (State, Out, Decision) ⇒ Either[Out2, (Out2, Interval)])(implicit trace: Trace): WithState[State, Env, In, Out2]

    Permalink

    Returns a new schedule that reconsiders every decision made by this schedule, possibly modifying the next interval and the output type in the process.

  66. def reconsiderZIO[Env1 <: Env, In1 <: In, Out2](f: (State, Out, Decision) ⇒ URIO[Env1, Either[Out2, (Out2, Interval)]]): WithState[State, Env1, In1, Out2]

    Permalink

    Returns a new schedule that effectfully reconsiders every decision made by this schedule, possibly modifying the next interval and the output type in the process.

  67. def repetitions(implicit trace: Trace): WithState[(State, Long), Env, In, Long]

    Permalink

    Returns a new schedule that outputs the number of repetitions of this one.

  68. final def resetAfter(duration: zio.Duration)(implicit trace: Trace): WithState[(State, Option[OffsetDateTime]), Env, In, Out]

    Permalink

    Return a new schedule that automatically resets the schedule to its initial state after some time of inactivity defined by duration.

  69. final def resetWhen(f: (Out) ⇒ Boolean): WithState[State, Env, In, Out]

    Permalink

    Resets the schedule when the specified predicate on the schedule output evaluates to true.

  70. def right[X]: WithState[(Unit, State), Env, Either[X, In], Either[X, Out]]

    Permalink

    Returns a new schedule that makes this schedule available on the Right side of an Either input, allowing propagating some type X through this channel on demand.

  71. def run(now: OffsetDateTime, input: Iterable[In])(implicit trace: Trace): URIO[Env, Chunk[Out]]

    Permalink

    Runs a schedule using the provided inputs, and collects all outputs.

  72. def second[X]: WithState[(Unit, State), Env, (X, In), (X, Out)]

    Permalink

    Returns a new schedule that packs the input and output of this schedule into the second element of a tuple.

    Returns a new schedule that packs the input and output of this schedule into the second element of a tuple. This allows carrying information through this schedule.

  73. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  74. def tapInput[Env1 <: Env, In1 <: In](f: (In1) ⇒ URIO[Env1, Any]): WithState[State, Env1, In1, Out]

    Permalink

    Returns a new schedule that effectfully processes every input to this schedule.

  75. def tapOutput[Env1 <: Env](f: (Out) ⇒ URIO[Env1, Any]): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule that effectfully processes every output from this schedule.

  76. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  77. def unionWith[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(f: (Intervals, Intervals) ⇒ Intervals)(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    Returns a new schedule that combines this schedule with the specified schedule, continuing as long as either schedule wants to continue and merging the next intervals according to the specified merge function.

  78. def unit(implicit trace: Trace): WithState[State, Env, In, Unit]

    Permalink

    Returns a new schedule that maps the output of this schedule to unit.

  79. def untilInput[In1 <: In](f: (In1) ⇒ Boolean)(implicit trace: Trace): WithState[State, Env, In1, Out]

    Permalink

    Returns a new schedule that continues until the specified predicate on the input evaluates to true.

  80. def untilInputZIO[Env1 <: Env, In1 <: In](f: (In1) ⇒ URIO[Env1, Boolean])(implicit trace: Trace): WithState[State, Env1, In1, Out]

    Permalink

    Returns a new schedule that continues until the specified effectful predicate on the input evaluates to true.

  81. def untilOutput(f: (Out) ⇒ Boolean)(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that continues until the specified predicate on the output evaluates to true.

  82. def untilOutputZIO[Env1 <: Env](f: (Out) ⇒ URIO[Env1, Boolean])(implicit trace: Trace): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule that continues until the specified effectful predicate on the output evaluates to true.

  83. def upTo(duration: zio.Duration)(implicit trace: Trace): WithState[(State, Option[OffsetDateTime]), Env, In, Out]

    Permalink

    A schedule that recurs during the given duration

  84. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. def whileInput[In1 <: In](f: (In1) ⇒ Boolean)(implicit trace: Trace): WithState[State, Env, In1, Out]

    Permalink

    Returns a new schedule that continues for as long the specified predicate on the input evaluates to true.

  88. def whileInputZIO[Env1 <: Env, In1 <: In](f: (In1) ⇒ URIO[Env1, Boolean]): WithState[State, Env1, In1, Out]

    Permalink

    Returns a new schedule that continues for as long the specified effectful predicate on the input evaluates to true.

  89. def whileOutput(f: (Out) ⇒ Boolean)(implicit trace: Trace): WithState[State, Env, In, Out]

    Permalink

    Returns a new schedule that continues for as long the specified predicate on the output evaluates to true.

  90. def whileOutputZIO[Env1 <: Env](f: (Out) ⇒ URIO[Env1, Boolean]): WithState[State, Env1, In, Out]

    Permalink

    Returns a new schedule that continues for as long the specified effectful predicate on the output evaluates to true.

  91. def zip[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    A named method for &&.

  92. def zipLeft[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State), Env1, In1, Out]

    Permalink

    The same as &&, but ignores the right output.

  93. def zipRight[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit trace: Trace): WithState[(State, State), Env1, In1, Out2]

    Permalink

    The same as &&, but ignores the left output.

  94. def zipWith[Env1 <: Env, In1 <: In, Out2, Out3](that: Schedule[Env1, In1, Out2])(f: (Out, Out2) ⇒ Out3)(implicit trace: Trace): WithState[(State, State), Env1, In1, Out3]

    Permalink

    Equivalent to zip followed by map.

  95. def ||[Env1 <: Env, In1 <: In, Out2](that: Schedule[Env1, In1, Out2])(implicit zippable: Zippable[Out, Out2]): WithState[(State, State), Env1, In1, Out]

    Permalink

    Returns a new schedule that performs a geometric union on the intervals defined by both schedules.

  96. def |||[Env1 <: Env, Out1 >: Out, In2](that: Schedule[Env1, In2, Out1])(implicit trace: Trace): WithState[(State, State), Env1, Either[In, In2], Out1]

    Permalink

    Returns a new schedule that chooses between two schedules with a common output.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped