Type Members

1.  sealed abstract class Command extends AnyRef

   Commands instruct the queue to do things

2.  final case class CommandReply[A](event: CommandReplyEvent, carry: Option[A]) extends CommandReplyEvent with Product with Serializable

   A reply to a command request

   A reply to a command request

   A

   The type of data carried through

   event

   An event in relation to a reply

   carry

   Any data to be carried through the command request

3.  sealed abstract class CommandReplyEvent extends AnyRef

   A reply to a command

4.  final case class CommandRequest[A](command: Command, carry: Option[A]) extends Product with Serializable

   Send a command to a queue with optional data to carry through - will cause a CommandReply to be replied

   Send a command to a queue with optional data to carry through - will cause a CommandReply to be replied

   A

   The type of data to carry through

   command

   The command to send

   carry

   The data to carry though

5.  trait Committable extends AnyRef

   Something that can be committed, having a source topic and offset.

6.  sealed abstract class Event extends AnyRef

   An event is something that a queue yields when it is being tailed

7.  type Headers = Seq[(String, ByteString)]

   Headers are additional data that can be carried with the data of a message

8.  trait Provider[T <: DurableQueue] extends AnyRef

   A Provider is used by Application to acquire an instance of a DurableQueue.

   A Provider is used by Application to acquire an instance of a DurableQueue. Providers are mixed into the class that extends Application.

9.  final case class Received(key: Long, data: ByteString, offset: Long, headers: Headers, source: Topic) extends Event with Committable with Product with Serializable

   Represents bytes being received on the queue along with its associated offset

   Represents bytes being received on the queue along with its associated offset

   key

   a key for partitioning i.e. "grouping" data belonging to the same "thing" - like a database identifier

   data

   the data received

   offset

   the offset of the data in the queue

   headers

   additional headers associated with the data

   source

   the topic that omitted the event

10.  final case class Send(key: Long, data: ByteString, target: Topic, headers: Headers) extends Command with Product with Serializable

    Send data to a append to a queue with optional data to carry through - will cause a SendAck to be replied

    Send data to a append to a queue with optional data to carry through - will cause a SendAck to be replied

    key

    a key for partitioning i.e. "grouping" data belonging to the same "thing" - like a database identifier

    data

    The data to send

    target

    The target topic

    headers

    additional headers associated with the data

11.  type Topic = String

    A topic is an identifier representing a queue for appending and tailing to and from respectively.

    A topic is an identifier representing a queue for appending and tailing to and from respectively. By convention, only [a-zA-Z0-9\\._\\-] should be allowed as per Kafka. Additionally, colon delimited names (:) may be used as a prefix to denote namespaces. The absence of any namespaces will result in a "default" name space being used. The default namespace is provided on instantiating the DurableQueue.