spice-core
API
Generated with
spice-core/spice.util/WorkCache

WorkCache

spice.util.WorkCache
trait WorkCache[Key, Result]

WorkCache effectively operates on a Key to guarantee that two jobs for the same Key are not concurrently processed and additional checks on the Key will wait for the same result.

Attributes

Key

the key tied to the work

Result

the result of the work

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

protected def persisted(key: Key): IO[Option[Result]]

Check for a persisted result. Work that is completed by work should persist to be able to be retrieved by this call.

Check for a persisted result. Work that is completed by work should persist to be able to be retrieved by this call.

Attributes

key

the Key to look up

Returns:

Some(result) if the work has already been done for this key, None otherwise to say that the work should be done.

protected def work(key: Key): IO[WorkResult[Result]]

Execute the work to generate the Result for this Key. The contract of this method is to persist the result so that it may be retrieved by the persisted method.

Execute the work to generate the Result for this Key. The contract of this method is to persist the result so that it may be retrieved by the persisted method.

Attributes

key

the Key to do work for

Returns:

the Result of the work

Concrete methods

def apply(key: Key): IO[Result]

Retrieve the Result for this Key doing work if necessary and retrieving from persisted state if available.

Retrieve the Result for this Key doing work if necessary and retrieving from persisted state if available.

Attributes

protected def errorHandler(key: Key, throwable: Throwable): Result
Generated with