SnapshotStorage

Implementations of this interface deal with persisting snapshots so that they don't need to be recomputed every time. Specifically, implementations do NOT deal with generating snapshots, only storing/retrieving any persisted snapshot.

F: Container around operations on an underlying data store e.g. Task.
K: The type of the key for snapshots. This does not need to be the same as for the event stream itself.
V: The type of the value wrapped by Snapshots that this store persists.

Linear Supertypes

AnyRef, Any

Abstract Value Members

abstract def get(key: K, sequence: SequenceQuery[S]): F[Snapshot[S, V]]

Retrieve a snapshot before the given sequence number.
Retrieve a snapshot before the given sequence number. We typically specify a sequence number if we want to get some old snapshot i.e. the latest persisted snapshot may have been generated after the point in time that we're interested in.
key
The key
sequence
What sequence we want to get the snapshot for (earliest snapshot, latest, or latest before some sequence)
returns
The snapshot, a NoSnapshot if there was no snapshot for the given conditions.
abstract def put(snapshotKey: K, snapshot: Snapshot[S, V], mode: SnapshotStoreMode): F[\/[Error, Snapshot[S, V]]]

Save a given snapshot
Save a given snapshot
snapshotKey
The key
snapshot
The snapshot to save
mode
Defines whether the given snapshot should be deemed the earliest point in the event stream (Epoch) or not (Cache)
returns
Either a Throwable (for error) or the saved snapshot.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object SnapshotStorage | package stream

trait SnapshotStorage[F[_], K, S, V] extends AnyRef

Abstract Value Members

abstract def get(key: K, sequence: SequenceQuery[S]): F[Snapshot[S, V]]

abstract def put(snapshotKey: K, snapshot: Snapshot[S, V], mode: SnapshotStoreMode): F[\/[Error, Snapshot[S, V]]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped