final case class Context(scheduler: Scheduler, connection: StackedCancelable, frameRef: FrameIndexRef, options: Options) extends Product with Serializable
The Context
under which Task is supposed to be executed.
This definition is of interest only when creating tasks with Task.unsafeCreate, which exposes internals and is considered unsafe to use.
- scheduler
is the Scheduler in charge of evaluation on
runAsync
.- connection
is the StackedCancelable that handles the cancellation on
runAsync
- frameRef
is a thread-local counter that keeps track of the current frame index of the run-loop. The run-loop is supposed to force an asynchronous boundary upon reaching a certain threshold, when the task is evaluated with monix.execution.ExecutionModel.BatchedExecution. And this
frameIndexRef
should be reset whenever a real asynchronous boundary happens. See the description of FrameIndexRef.- options
is a set of options for customizing the task's behavior upon evaluation.
- Source
- Task.scala
- Alphabetic
- By Inheritance
- Context
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Context(scheduler: Scheduler, connection: StackedCancelable, frameRef: FrameIndexRef, options: Options)
- scheduler
is the Scheduler in charge of evaluation on
runAsync
.- connection
is the StackedCancelable that handles the cancellation on
runAsync
- frameRef
is a thread-local counter that keeps track of the current frame index of the run-loop. The run-loop is supposed to force an asynchronous boundary upon reaching a certain threshold, when the task is evaluated with monix.execution.ExecutionModel.BatchedExecution. And this
frameIndexRef
should be reset whenever a real asynchronous boundary happens. See the description of FrameIndexRef.- options
is a set of options for customizing the task's behavior upon evaluation.
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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val connection: StackedCancelable
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
executionModel: ExecutionModel
Helper that returns the ExecutionModel specified by the scheduler.
Helper that returns the ExecutionModel specified by the scheduler.
- Annotations
- @inline()
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val frameRef: FrameIndexRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val options: Options
- val scheduler: Scheduler
-
def
shouldCancel: Boolean
Helper that returns
true
if the currentTask
run-loop should be canceled orfalse
otherwise.Helper that returns
true
if the currentTask
run-loop should be canceled orfalse
otherwise.- Annotations
- @inline()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomic
types, as alternative tojava.util.concurrent.atomic
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observable
pattern:Observable
implementationsmonix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.
monix.cats is the optional integration with the Cats library, providing translations for the types described in
monix.types
.monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in
monix.types
.