Trait

io.atlassian.event.source.EventSource

API

Related Doc: package EventSource

Permalink

trait API[F[_]] extends AnyRef

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)

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. API
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def C: Catchable[F]

    Permalink
    Attributes
    protected

  2. implicit abstract def M: Monad[F]

    Permalink
    Attributes
    protected

  3. abstract def store: Storage[F]

    Permalink

    returns

    Underlying store of events

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def get(key: K): F[Option[V]]

    Permalink

    Return the current view of the data for key 'key'

  10. final def getAt(key: K, time: DateTime): F[Option[V]]

    Permalink

    Return the view of the data for the key 'key' at the specified timestamp.

    Return the view of the data for the key 'key' at the specified timestamp.

    key

    The key

    time

    The timestamp at which we want to see the view of the data

    returns

    view of the data with events up to the given time stamp.

  11. final def getAt(key: K, seq: S): F[Option[V]]

    Permalink

    Return the view of the data for the key 'key' at the specified sequence number.

    Return the view of the data for the key 'key' at the specified sequence number.

    key

    the key

    seq

    the sequence number of the event at which we want the see the view of the data.

    returns

    view of the data at event with sequence 'seq'

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def getHistory(key: K): F[Process[F, Snapshot]]

    Permalink

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def save(key: K, operation: Operation[V]): F[Result[V]]

    Permalink

    Save a value for the given key.

    Save a value for the given key.

    Pass in the function that creates a possible transform, given the current value if there is one.

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

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped