raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

=doc Update Using timers section with new methods. (#31324)

Browse source
This commit is contained in:
kerr 2022-04-14 17:43:03 +08:00 • committed by GitHub
parent 3a9126be8c
commit bfafb8cf0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
akka-docs/src/main/paradox/stream/stream-customize.md
View file

@ -345,11 +345,11 @@ Java
### Using timers ### Using timers
It is possible to use timers in `GraphStages` by using `TimerGraphStageLogic` as the base class for It is possible to use timers in `GraphStages` by using `TimerGraphStageLogic` as the base class for
the returned logic. Timers can be scheduled by calling one of `scheduleOnce(key,delay)`, `schedulePeriodically(key,period)` or the returned logic. Timers can be scheduled by calling one of `scheduleOnce(timerKey,delay)`, `scheduleAtFixedRate(timerKey,initialDelay,interval)` or
`schedulePeriodicallyWithInitialDelay(key,delay,period)` and passing an object as a key for that timer (can be any object, for example `scheduleWithFixedDelay(timerKey,initialDelay,interval)` and passing an object as a key for that timer (can be any object, for example
a `String`). The `onTimer(key)` method needs to be overridden and it will be called once the timer of `key` a `String`). The `onTimer(timerKey)` method needs to be overridden, and it will be called once the timer of `timerKey`
fires. It is possible to cancel a timer using `cancelTimer(key)` and check the status of a timer with fires. It is possible to cancel a timer using `cancelTimer(timerKey)` and check the status of a timer with
`isTimerActive(key)`. Timers will be automatically cleaned up when the operator completes. `isTimerActive(timerKey)`. Timers will be automatically cleaned up when the operator completes.
Timers can not be scheduled from the constructor of the logic, but it is possible to schedule them from the Timers can not be scheduled from the constructor of the logic, but it is possible to schedule them from the
`preStart()` lifecycle hook. `preStart()` lifecycle hook.