final class CanBlock extends AnyRef

Marker for blocking operations that need to be disallowed on top of JavaScript engines, or other platforms that don't support the blocking of threads.

As sample, lets implement a low-level blocking operation; but kids, don't do this at home, since this is error prone and you already have Scala's Await.result, this sample being shown for pedagogical purposes:

import monix.execution.schedulers.CanBlock
import java.util.concurrent.CountDownLatch
import scala.concurrent.{ExecutionContext, Future}
import scala.util.Try

def block[A](fa: Future[A])
  (implicit ec: ExecutionContext, permit: CanBlock): Try[A] = {

  var result = Option.empty[Try[A]]
  val latch = new CountDownLatch(1)

  fa.onComplete { r =>
    result = r
    latch.countDown()
  }

  latch.await()
  result.get
}

And then for JavaScript engines (Scala.js) you could describe the same function, with the same signature, but without any implementation, since this operation isn't supported:

def block[A](fa: Future[A])
  (implicit ec: ExecutionContext, permit: CanBlock): Try[A] =
  throw new UnsupportedOperationException("Cannot block threads on top of JavaScript")

Now in usage, when the caller is invoking block as described, it will work without issues on top of the JVM, but when compiled with Scala.js it will trigger a message like this:

[error] Playground.scala:30:8: Blocking operations aren't supported
[error] on top of JavaScript, because it cannot block threads!
[error] Please use asynchronous API calls.
[error]   block(Future(1))
[error]        ^
Annotations
@implicitNotFound( ... )
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CanBlock
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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