final class OrderedCancelable extends Multi
Represents a Cancelable whose underlying cancelable reference can be swapped for another and that has the capability to force ordering of updates.
For the most part it's very similar with MultiAssignCancelable:
val s = OrderedCancelable() s := c1 // sets the underlying cancelable to c1 s := c2 // swaps the underlying cancelable to c2 s.cancel() // also cancels c2 s := c3 // also cancels c3, because s is already canceled
However it also has the capability of doing orderedUpdate:
val s = OrderedCancelable() ec.execute(new Runnable { def run() = s.orderedUpdate(ref2, 2) }) // The ordered updates are guarding against reversed ordering // due to the created thread being able to execute before the // following update s.orderedUpdate(ref1, 1)
Also see:
- SerialCancelable, which is similar, except that it cancels the old cancelable upon assigning a new cancelable
- SingleAssignCancelable that is effectively a forward reference that can be assigned at most once
- MultiAssignCancelable that's very similar with
OrderedCancelable, but simpler, without the capability of doing ordered updates and possibly more efficient
- Source
- OrderedCancelable.scala
- Alphabetic
- By Inheritance
- OrderedCancelable
- Multi
- Bool
- BooleanCancelable
- AssignableCancelable
- Cancelable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def :=(value: Cancelable): OrderedCancelable.this.type
Updates the internal reference of this assignable cancelable to the given value.
Updates the internal reference of this assignable cancelable to the given value.
If this cancelable is already canceled, then
valueis going to be canceled on assignment as well.- returns
this
- Definition Classes
- OrderedCancelable → AssignableCancelable
- Annotations
- @tailrec()
- def cancel(): Unit
Cancels the unit of work represented by this reference.
Cancels the unit of work represented by this reference.
Guaranteed idempotency - calling it multiple times should have the same side-effect as calling it only once. Implementations of this method should also be thread-safe.
- Definition Classes
- OrderedCancelable → Cancelable
- def currentOrder: Long
Returns the current order index, useful for working with orderedUpdate in instances where the OrderedCancelable reference is shared.
- def isCanceled: Boolean
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- OrderedCancelable → BooleanCancelable
- def orderedUpdate(value: Cancelable, order: Long): OrderedCancelable.this.type
An ordered update is an update with an order attached and if the currently stored reference has on order that is greater than the update, then the update is ignored.
An ordered update is an update with an order attached and if the currently stored reference has on order that is greater than the update, then the update is ignored.
Useful to force ordering for concurrent updates.
- Annotations
- @tailrec()
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.