EventSource

Type Members

1. trait API[F[_]] extends AnyRef

   

   This is the main interface for consumers of the Event source.

   This is the main interface for consumers of the Event source.

   Implementations contain logic to create a transform given a value to save.

   Upon construction of an API, a suitable Events store needs to be provided.

   F

   Container type for API operations. It needs to be a Monad and a Catchable (e.g. scalaz Task)

2. case class Event(id: EventId, time: DateTime, operation: Transform[V]) extends Product with Serializable

   

3. case class EventId(key: K, sequence: S) extends Product with Serializable

   

   A event is identified by the key and an incrementing sequence number

   A event is identified by the key and an incrementing sequence number

   key

   The key

   sequence

   the sequence number

4. sealed trait Snapshot extends AnyRef

   

   A Snapshot wraps an optional value, and tags it with an event Id.

   A Snapshot wraps an optional value, and tags it with an event Id. We can say a 'snapshot' S of key K at event S.at is value S.value

   The event Id is quite a useful thing in addition to the value of the snapshot.

   This is only used internally within an event source.

5. trait Storage[F[_]] extends AnyRef

   

   A source of events.

   A source of events. Implementations wrap around an underlying data store (e.g. in-memory map or DynamoDB).

   F

   Container around operations on an underlying data store. F must be a Monad and a Catchable (e.g. Task).

   Attributes

   protected