Subscriptions

Type Members

1. final case class ConnectionClosedCallback(connectionClosedCallback: (ConnectionClosedData) ⇒ Unit) extends Product with Serializable

   

2. final case class ConnectionClosedData(occurredAt: OffsetDateTime, subscriptionId: SubscriptionId, oldStreamId: StreamId, cancelledByClient: Boolean) extends Product with Serializable

   

3. final case class Cursor(partition: Partition, offset: String, eventType: EventTypeName, cursorToken: CursorToken) extends Product with Serializable

   

4. sealed abstract class Errors extends GeneralError

   

5. sealed abstract class EventCallback[T] extends AnyRef

   

6. final case class EventCallbackData[T](subscriptionEvent: SubscriptionEvent[T], streamId: StreamId, request: HttpRequest, flowId: Option[FlowId]) extends Product with Serializable

   
   flowId

   The current flowId, if EventCallback.separateFlowId is true then the new flowId will be here else it will use the flowId used when Subscriptions.eventsStreamed is called

7. final case class EventJsonParsingException(subscriptionEventInfo: SubscriptionEventInfo, jsonParsingException: mdedetrich.akka.stream.support.CirceStreamSupport.JsonParsingException) extends Exception with Product with Serializable

   

8. final case class EventStreamContext(flowId: FlowId, subscriptionId: SubscriptionId, streamId: StreamId, subscriptionsClient: Subscriptions) extends Product with Serializable

   
   flowId

   Current flow id

   subscriptionId

   Current Stream Subscription id

   streamId

   Current Stream Id

   subscriptionsClient

   the current subscription client that is being used

9. final case class EventStreamSupervisionDecider(privateDecider: (EventStreamContext) ⇒ Decider) extends Product with Serializable

   

10. final case class EventTypeStats(eventType: EventTypeName, partitions: List[Partition]) extends Product with Serializable

    

11. final case class NakadiSource[T](streamId: StreamId, source: Source[SubscriptionEvent[T], UniqueKillSwitch], request: HttpRequest) extends Product with Serializable

    

    Nakadi stream represented as an akka-stream Source

12. final case class StreamConfig(maxUncommittedEvents: Option[Int] = None, batchLimit: Option[Int] = None, streamLimit: Option[Int] = None, batchFlushTimeout: Option[FiniteDuration] = None, streamTimeout: Option[FiniteDuration] = None, streamKeepAliveLimit: Option[Int] = None, commitTimeout: Option[FiniteDuration] = None) extends Product with Serializable

    

    Configuration for a stream

    Configuration for a stream

    maxUncommittedEvents

    The amount of uncommitted events Nakadi will stream before pausing the stream. When in paused state and commit comes - the stream will resume. Minimal value is 1.

    batchLimit

    Maximum number of SubscriptionEvent's in each chunk (and therefore per partition) of the stream. If 0 or unspecified will buffer Events indefinitely and flush on reaching of batchFlushTimeout

    streamLimit

    Maximum number of SubscriptionEvent's in this stream (over all partitions being streamed in this connection). If 0 or undefined, will stream batches indefinitely. Stream initialization will fail if streamLimit is lower than batchLimit.

    batchFlushTimeout

    Maximum time in seconds to wait for the flushing of each chunk (per partition). If the amount of buffered Events reaches batchLimit before this batchFlushTimeout is reached, the messages are immediately flushed to the client and batch flush timer is reset. If 0 or undefined, will assume 30 seconds.

    streamTimeout

    Maximum time in seconds a stream will live before connection is closed by the server. If 0 or unspecified will stream indefinitely. If this timeout is reached, any pending messages (in the sense of stream_limit) will be flushed to the client. Stream initialization will fail if streamTimeout is lower than batchFlushTimeout.

    streamKeepAliveLimit

    Maximum number of empty keep alive batches to get in a row before closing the connection. If 0 or undefined will send keep alive messages indefinitely.

    commitTimeout

    Maximum amount of seconds that nakadi will be waiting for commit after sending a batch to a client. Setting commit_timeout to 0 is equal to setting it to the maximum allowed value - 60 seconds.