Trait

io.atlassian.event.stream

EventStorage

Related Doc: package stream

Permalink

trait EventStorage[F[_], K, S, E] extends AnyRef

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 e.g. Task.

Self Type
EventStorage[F, K, S, E]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EventStorage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def get(key: K, fromSeq: Option[S]): Process[F, Event[K, S, E]]

    Permalink

    Retrieve a stream of events from the underlying data store.

    Retrieve a stream of events from the underlying data store. This stream should take care of pagination and cleanup of any underlying resources (e.g. closing connections if required).

    key

    The key

    fromSeq

    The starting sequence to get events from (exclusive). None to get from the start.

    returns

    Stream of events.

  2. abstract def latest(key: K): OptionT[F, Event[K, S, E]]

    Permalink

    Get the latest event.

    Get the latest event.

    key

    The key

    returns

    Single event if found.

  3. abstract def put(event: Event[K, S, E]): F[\/[EventStreamError, Event[K, S, E]]]

    Permalink

    Save the given event.

    Save the given event.

    returns

    Either an Error or the event that was saved. Other non-specific errors should be available through the container F.

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 getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  12. def mapKS[KK, SS](k: (KK) ⇒ K, kk: (K) ⇒ KK, s: (SS) ⇒ S, ss: (S) ⇒ SS)(implicit F: Functor[F]): EventStorage[F, KK, SS, E] { def updateKey(event: io.atlassian.event.stream.Event[K,S,E]): io.atlassian.event.stream.Event[KK,SS,E] }

    Permalink
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped