trait Timed[F[_], O] extends AnyRef
An abstraction for writing Pull
computations that can timeout
while reading from a Stream
.
A Pull.Timed
is not created or intepreted directly, but by
calling Stream.ToPull.timed.
yourStream.pull.timed(tp => ...).stream
The argument to timed
is a Pull.Timed[F, O] => Pull[F, O2, R]
function, which describes the pulling logic and is often recursive,
with shape:
def go(timedPull: Pull.Timed[F, A]): Pull[F, B, Unit] = timedPull.uncons.flatMap { case Some((Right(chunk), next)) => doSomething >> go(next) case Some((Left(_), next)) => doSomethingElse >> go(next) case None => Pull.done }
Where doSomething
and doSomethingElse
are Pull
computations
such as Pull.output
, in addition to Pull.Timed.timeout
.
See below for detailed descriptions of timeout
and uncons
, and
look at the Stream.ToPull.timed scaladoc for an example of usage.
- Source
- Pull.scala
- Alphabetic
- By Inheritance
- Timed
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type Timeout
Abstract Value Members
- abstract def timeout(t: FiniteDuration): Pull[F, INothing, Unit]
Asynchronously starts a timeout that will be received by
uncons
aftert
, and immediately returns.Asynchronously starts a timeout that will be received by
uncons
aftert
, and immediately returns.Timeouts are resettable: if
timeout
executes whilst a previous timeout is pending, it will cancel it before starting the new one, so that there is at most one timeout in flight at any given time. The implementation guards against stale timeouts: after resetting a timeout, a subsequentuncons
is guaranteed to never receive an old one.Timeouts can be reset to any
t
, longer or shorter than the previous timeout, but a duration of 0 is treated specially, in that it will cancel a pending timeout but not start a new one.Note: the very first execution of
timeout
does not start running until the first call touncons
, but subsequent calls proceed independently after that. - abstract def uncons: Pull[F, INothing, Option[(Either[Timeout, Chunk[O]], Timed[F, O])]]
Waits for either a chunk of elements to be available in the source stream, or a timeout to trigger.
Waits for either a chunk of elements to be available in the source stream, or a timeout to trigger. Whichever happens first is provided as the resource of the returned pull, alongside a new timed pull that can be used for awaiting again. A
None
is returned as the resource of the pull upon reaching the end of the stream.Receiving a timeout is not a fatal event: the evaluation of the current chunk is not interrupted, and the next timed pull is still returned for further iteration. The lifetime of timeouts is handled by explicit calls to the
timeout
method:uncons
does not start, restart or cancel any timeouts.Note that the type of timeouts is existential in
Pull.Timed
(hidden, basically) so you cannot do anything on it except for pattern matching, which is best done as aLeft(_)
case.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated