scala.concurrent (original) (raw)
Await is what is used to ensure proper handling of blocking for Awaitable instances.
Await is what is used to ensure proper handling of blocking for Awaitable instances.
While occasionally useful, e.g. for testing, it is recommended that you avoid Await whenever possible— instead favoring combinators and/or callbacks. Await's result and ready methods will block the calling thread's execution until they return, which will cause performance degradation, and possibly, deadlock issues.
Attributes
Source
Supertypes
Self type
An object that may eventually be completed with a result value of type T which may be awaited using blocking methods.
An object that may eventually be completed with a result value of type T which may be awaited using blocking methods.
The Await object provides methods that allow accessing the result of an Awaitable by blocking the current thread until the Awaitable has been completed or a timeout has occurred.
Attributes
Source
Supertypes
Known subtypes
Marker trait to indicate that a Runnable is Batchable by BatchingExecutors
Marker trait to indicate that a Runnable is Batchable by BatchingExecutors
Attributes
Source
Supertypes
Known subtypes
Self type
A context to be notified by scala.concurrent.blocking when a thread is about to block. In effect this trait provides the implementation for scala.concurrent.Await. scala.concurrent.Await.result and scala.concurrent.Await.ready locates an instance of BlockContext by first looking for one provided through BlockContext.withBlockContext and failing that, checking whether Thread.currentThread is an instance of BlockContext. So a thread pool can have its java.lang.Thread instances implement BlockContext. There's a default BlockContext used if the thread doesn't implement BlockContext.
Typically, you'll want to chain to the previous BlockContext, like this:
val oldContext = BlockContext.current
val myContext = new BlockContext {
override def blockOn[T](thunk: => T)(implicit permission: CanAwait): T = {
// you'd have code here doing whatever you need to do
// when the thread is about to block.
// Then you'd chain to the previous context:
oldContext.blockOn(thunk)
}
}
BlockContext.withBlockContext(myContext) {
// then this block runs with myContext as the handler
// for scala.concurrent.blocking
}
Attributes
Companion
Source
Supertypes
This marker trait is used by Await to ensure that Awaitable.ready and Awaitable.result are not directly called by user code. An implicit instance of this trait is only available when user code is currently calling the methods on Await.
Attributes
Source
Supertypes
An ExecutionContext can execute program logic asynchronously, typically but not necessarily on a thread pool.
An ExecutionContext can execute program logic asynchronously, typically but not necessarily on a thread pool.
A general purpose ExecutionContext must be asynchronous in executing any Runnable that is passed into its execute-method. A special purpose ExecutionContext may be synchronous but must only be passed to code that is explicitly safe to be run using a synchronously executing ExecutionContext.
APIs such as Future.onComplete require you to provide a callback and an implicit ExecutionContext. The implicit ExecutionContext will be used to execute the callback.
While it is possible to simply import scala.concurrent.ExecutionContext.Implicits.global to obtain an implicit ExecutionContext, application developers should carefully consider where they want to define the execution policy; ideally, one place per application — or per logically related section of code — will make a decision about which ExecutionContext to use. That is, you will mostly want to avoid hardcoding, especially via an import, scala.concurrent.ExecutionContext.Implicits.global. The recommended approach is to add (implicit ec: ExecutionContext) to methods, or class constructor parameters, which need an ExecutionContext.
Then locally import a specific ExecutionContext in one place for the entire application or module, passing it implicitly to individual methods. Alternatively define a local implicit val with the required ExecutionContext.
A custom ExecutionContext may be appropriate to execute code which blocks on IO or performs long-running computations. ExecutionContext.fromExecutorService and ExecutionContext.fromExecutor are good ways to create a custom ExecutionContext.
The intent of ExecutionContext is to lexically scope code execution. That is, each method, class, file, package, or application determines how to run its own code. This avoids issues such as running application callbacks on a thread pool belonging to a networking library. The size of a networking library's thread pool can be safely configured, knowing that only that library's network operations will be affected. Application callback execution can be configured separately.
Attributes
Companion
Source
Supertypes
Known subtypes
Contains factory methods for creating execution contexts.
Contains factory methods for creating execution contexts.
Attributes
Companion
Source
Supertypes
Self type
A Future represents a value which may or may not be currently available, but will be available at some point, or an exception if that value could not be made available.
A Future represents a value which may or may not be currently available, but will be available at some point, or an exception if that value could not be made available.
Asynchronous computations are created by calling Future.apply, which yields instances of Future. Computations are executed using an ExecutionContext, which is usually supplied implicitly, and which is commonly backed by a thread pool.
import ExecutionContext.Implicits.global
val s = "Hello"
val f: Future[String] = Future {
s + " future!"
}
f foreach {
msg => println(msg)
}
Note that the global context is convenient but restricted: "fatal" exceptions are reported only by printing a stack trace, and the underlying thread pool may be shared by a mix of jobs. For any nontrivial application, see the caveats explained at ExecutionContext and also the overview linked below, which explains exception handling in depth.
Attributes
See also
Companion
Source
Supertypes
Known subtypes
Future companion object.
Future companion object.
Attributes
Companion
Source
Supertypes
Self type
Promise is an object which can be completed with a value or failed with an exception.
Promise is an object which can be completed with a value or failed with an exception.
A promise should always eventually be completed, whether for success or failure, in order to avoid unintended resource retention for any associated Futures' callbacks or transformations.
Attributes
Companion
Source
Supertypes
This class provides a simple FIFO queue of data objects, which are read by one or more reader threads.
This class provides a simple FIFO queue of data objects, which are read by one or more reader threads.
Type parameters
A
type of data exchanged
Attributes
Deprecated
[Since version 2.13.0] Use `java.util.concurrent.LinkedTransferQueue` instead.
Source
Supertypes
A DelayedLazyVal is a wrapper for lengthy computations which have a valid partially computed result.
A DelayedLazyVal is a wrapper for lengthy computations which have a valid partially computed result.
The first argument is a function for obtaining the result at any given point in time, and the second is the lengthy computation. Once the computation is complete, the apply method will stop recalculating it and return a fixed value from that point forward.
Value parameters
body
the computation to run to completion in another thread
f
the function to obtain the current value at any point in time
Attributes
Deprecated
[Since version 2.13.0] `DelayedLazyVal` Will be removed in the future.
Source
Supertypes
The JavaConversions object provides implicit conversions supporting interoperability between Scala and Java concurrency classes.
The JavaConversions object provides implicit conversions supporting interoperability between Scala and Java concurrency classes.
Attributes
Deprecated
[Since version 2.13.0] Use the factory methods in `ExecutionContext` instead
Source
Supertypes
Self type
Attributes
Deprecated
[Since version 2.13.0] Superseded by `scala.concurrent.Batchable`
Source
Supertypes
Self type
A SyncChannel allows one to exchange data synchronously between a reader and a writer thread.
A SyncChannel allows one to exchange data synchronously between a reader and a writer thread. The writer thread is blocked until the data to be written has been read by a corresponding reader thread.
Attributes
Deprecated
[Since version 2.13.0] Use `java.util.concurrent.Exchanger` instead.
Source
Supertypes
A class to provide safe concurrent access to a mutable cell.
A class to provide safe concurrent access to a mutable cell. All methods are synchronized.
Type parameters
A
type of the contained value
Attributes
Deprecated
[Since version 2.13.0] Use `java.util.concurrent.LinkedBlockingQueue with capacity 1` instead.
Source
Supertypes
Used to designate a piece of code which potentially blocks, allowing the current BlockContext to adjust the runtime's behavior.
Used to designate a piece of code which potentially blocks, allowing the current BlockContext to adjust the runtime's behavior. Properly marking blocking code may improve performance or avoid deadlocks.
Blocking on an Awaitable should be done using Await.result instead of blocking.
Value parameters
body
A piece of code which contains potentially blocking or long running calls.
Attributes
Throws
Source