Packages

sealed abstract class FrameIndexRef extends AnyRef

A reference that boxes a FrameIndex possibly using a thread-local.

This definition is of interest only when creating tasks with Task.unsafeCreate, which exposes internals and is considered unsafe to use.

In case the Task is executed with BatchedExecution, this class boxes a FrameIndex in order to transport it over light async boundaries, possibly using a ThreadLocal, since this index is not supposed to survive when threads get forked.

The FrameIndex is a counter that increments whenever a flatMap operation is evaluated. And with BatchedExecution, whenever that counter exceeds the specified threshold, an asynchronous boundary is automatically inserted. However this capability doesn't blend well with light asynchronous boundaries, for example Async tasks that never fork logical threads or TrampolinedRunnable instances executed by capable schedulers. This is why FrameIndexRef is part of the Context of execution for Task, available for asynchronous tasks that get created with Task.unsafeCreate.

Note that in case the execution model is not BatchedExecution then this reference is just a dummy, since there's no point in keeping a counter around, plus setting and fetching from a ThreadLocal can be quite expensive.

Source
Task.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FrameIndexRef
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def :=(update: FrameIndex): Unit

    Stores a new FrameIndex.

  2. abstract def apply(): FrameIndex

    Returns the current FrameIndex.

  3. abstract def reset(): Unit

    Resets the stored FrameIndex to 1, which is the default value that should be used after an asynchronous boundary happened.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped