Class/Object

eventstore

EsConnection

Related Docs: object EsConnection | package eventstore

Permalink

class EsConnection extends AnyRef

Maintains a full duplex connection to the EventStore

All operations are handled in a full async manner. Many threads can use an EsConnection at the same time or a single thread can make many asynchronous requests. To get the most performance out of the connection it is generally recommended to use it in this way.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EsConnection
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EsConnection(connection: ActorRef, factory: ActorRefFactory, settings: Settings = Settings.Default)

    Permalink

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to any2stringadd[EsConnection] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EsConnection, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to ArrowAssoc[EsConnection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def allStreamsSource(resolveLinkTos: Boolean = settings.resolveLinkTos, fromPositionExclusive: Option[Position] = None, credentials: Option[UserCredentials] = None, infinite: Boolean = true, readBatchSize: Int = settings.readBatchSize): Source[IndexedEvent, NotUsed]

    Permalink

    Creates a Source you can use to subscribes to all events.

    Creates a Source you can use to subscribes to all events. Existing events from position onwards are read from the Event Store and presented to the user of Source as if they had been pushed.

    Once the end of the stream is read the Source transparently (to the user) switches to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the position representing the last event processed.

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    fromPositionExclusive

    The position from which to start, or None to read all events

    credentials

    The optional user credentials to perform operation with

    infinite

    Whether to subscribe to the future events upon reading all current

    readBatchSize

    Number of events to be retrieved by client as single message

    returns

    A akka.stream.scaladsl.Source representing all streams

  7. def apply[OUT <: Out, IN <: In](out: OUT, credentials: Option[UserCredentials] = None)(implicit outIn: ClassTags[OUT, IN], ec: ExecutionContext): Future[IN]

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def continueTransaction(transactionId: Long, credentials: Option[UserCredentials] = None): EsTransaction

    Permalink

    Continues transaction by provided transaction ID.

    Continues transaction by provided transaction ID.

    EsTransaction allows the calling of multiple writes with multiple round trips over long periods of time between the caller and the event store. This method is only available through the TCP interface and no equivalent exists for the RESTful interface.

    transactionId

    The transaction ID that needs to be continued.

    credentials

    The optional user credentials to perform operation with

    returns

    EsTransaction for given transaction id

  11. def ensuring(cond: (EsConnection) ⇒ Boolean, msg: ⇒ Any): EsConnection

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to Ensuring[EsConnection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (EsConnection) ⇒ Boolean): EsConnection

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to Ensuring[EsConnection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): EsConnection

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to Ensuring[EsConnection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): EsConnection

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to Ensuring[EsConnection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to StringFormat[EsConnection] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getStreamMetadata(streamId: Id, credentials: Option[UserCredentials] = None)(implicit ec: ExecutionContext): Future[Content]

    Permalink
  21. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  26. def setStreamMetadata(streamId: Id, metadata: Content, expectedMetastreamVersion: ExpectedVersion = ExpectedVersion.Any, credentials: Option[UserCredentials] = None)(implicit ec: ExecutionContext): Future[Option[WriteResult]]

    Permalink
  27. def startTransaction(data: TransactionStart, credentials: Option[UserCredentials] = None): Future[EsTransaction]

    Permalink

    Starts a transaction in the event store on a given stream asynchronously

    Starts a transaction in the event store on a given stream asynchronously

    EsTransaction allows the calling of multiple writes with multiple round trips over long periods of time between the caller and the event store. This method is only available through the TCP interface and no equivalent exists for the RESTful interface.

    data

    Stream id and other params to star transaction

    credentials

    The optional user credentials to perform operation with

    returns

    A Future containing an actual transaction

  28. def streamSource(streamId: Id, fromEventNumberExclusive: Option[EventNumber] = None, resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None, infinite: Boolean = true, readBatchSize: Int = settings.readBatchSize): Source[Event, NotUsed]

    Permalink

    Creates a Source you can use to subscribe to a single event stream.

    Creates a Source you can use to subscribe to a single event stream. Existing events from event number onwards are read from the stream and presented to the user of Source as if they had been pushed.

    Once the end of the stream is read the Source transparently (to the user) switches to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the event number of the last event processed.

    streamId

    The stream to subscribe to

    fromEventNumberExclusive

    The event number from which to start, or None to read all events.

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    infinite

    Whether to subscribe to the future events upon reading all current

    readBatchSize

    Number of events to be retrieved by client as single message

    returns

    A akka.stream.scaladsl.Source representing the stream

  29. def subscribeToAll(observer: SubscriptionObserver[IndexedEvent], resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None): Closeable

    Permalink

    Subscribes to all events in the Event Store.

    Subscribes to all events in the Event Store. New events written to the stream while the subscription is active will be pushed to the client.

    observer

    A SubscriptionObserver to handle a new event received over the subscription

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    returns

    A Closeable representing the subscription which can be closed.

  30. def subscribeToAllFrom(observer: SubscriptionObserver[IndexedEvent], fromPositionExclusive: Option[Exact] = None, resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None): Closeable

    Permalink

    Subscribes to a all events.

    Subscribes to a all events. Existing events from position onwards are read from the Event Store and presented to the user of SubscriptionObserver as if they had been pushed.

    Once the end of the stream is read the subscription is transparently (to the user) switched to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the position representing the last event processed which appeared on the subscription.

    observer

    A SubscriptionObserver to handle a new event received over the subscription

    fromPositionExclusive

    The position from which to start, or None to read all events

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    returns

    A Closeable representing the subscription which can be closed.

  31. def subscribeToStream(streamId: Id, observer: SubscriptionObserver[Event], resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None): Closeable

    Permalink

    Subscribes to a single event stream.

    Subscribes to a single event stream. New events written to the stream while the subscription is active will be pushed to the client.

    streamId

    The stream to subscribe to

    observer

    A SubscriptionObserver to handle a new event received over the subscription

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    returns

    A Closeable representing the subscription which can be closed.

  32. def subscribeToStreamFrom(streamId: Id, observer: SubscriptionObserver[Event], fromNumberExclusive: Option[Exact] = None, resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None): Closeable

    Permalink

    Subscribes to a single event stream.

    Subscribes to a single event stream. Existing events from lastCheckpoint onwards are read from the stream and presented to the user of SubscriptionObserver as if they had been pushed.

    Once the end of the stream is read the subscription is transparently (to the user) switched to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the event number of the last event processed which appeared on the subscription.

    streamId

    The stream to subscribe to

    observer

    A eventstore.SubscriptionObserver to handle a new event received over the subscription

    fromNumberExclusive

    The event number from which to start, or None to read all events.

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    returns

    A Closeable representing the subscription which can be closed.

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

    Permalink
    Definition Classes
    AnyRef
  34. implicit val timeout: Timeout

    Permalink
  35. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def [B](y: B): (EsConnection, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EsConnection to ArrowAssoc[EsConnection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def allStreamsPublisher(resolveLinkTos: Boolean = settings.resolveLinkTos, fromPositionExclusive: Option[Position] = None, credentials: Option[UserCredentials] = None, infinite: Boolean = true, readBatchSize: Int = settings.readBatchSize): Publisher[IndexedEvent]

    Permalink

    Creates Publisher you can use to subscribes to a all events.

    Creates Publisher you can use to subscribes to a all events. Existing events from position onwards are read from the Event Store and presented to the user of Publisher as if they had been pushed.

    Once the end of the stream is read the subscription is transparently (to the user) switched to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the position representing the last event processed which appeared on the subscription.

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    fromPositionExclusive

    The position from which to start, or None to read all events

    credentials

    The optional user credentials to perform operation with

    infinite

    Whether to subscribe to the future events upon reading all current

    readBatchSize

    Number of events to be retrieved by client as single message

    returns

    A org.reactivestreams.Publisher representing all streams

    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.8) Use allStreamsSource(..).runWith(Sink.asPublisher(..)) instead.

  2. def future[OUT <: Out, IN <: In](out: OUT, credentials: Option[UserCredentials] = None)(implicit outIn: ClassTags[OUT, IN]): Future[IN]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) use apply instead

  3. def streamPublisher(streamId: Id, fromNumberExclusive: Option[EventNumber] = None, resolveLinkTos: Boolean = settings.resolveLinkTos, credentials: Option[UserCredentials] = None, infinite: Boolean = true, readBatchSize: Int = settings.readBatchSize): Publisher[Event]

    Permalink

    Creates Publisher you can use to subscribe to a single event stream.

    Creates Publisher you can use to subscribe to a single event stream. Existing events from lastCheckpoint onwards are read from the stream and presented to the user of Publisher as if they had been pushed.

    Once the end of the stream is read the subscription is transparently (to the user) switched to push new events as they are written.

    If events have already been received and resubscription from the same point is desired, use the event number of the last event processed which appeared on the subscription.

    streamId

    The stream to publish

    fromNumberExclusive

    The event number from which to start, or None to read all events.

    resolveLinkTos

    Whether to resolve LinkTo events automatically

    credentials

    The optional user credentials to perform operation with

    infinite

    Whether to subscribe to the future events upon reading all current

    readBatchSize

    Number of events to be retrieved by client as single message

    returns

    A org.reactivestreams.Publisher representing stream

    Annotations
    @deprecated
    Deprecated

    (Since version 5.0.8) Use streamSource(..).runWith(Sink.asPublisher(..)) instead.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EsConnection to any2stringadd[EsConnection]

Inherited by implicit conversion StringFormat from EsConnection to StringFormat[EsConnection]

Inherited by implicit conversion Ensuring from EsConnection to Ensuring[EsConnection]

Inherited by implicit conversion ArrowAssoc from EsConnection to ArrowAssoc[EsConnection]

Ungrouped