op_rabbit

Type Members

1. trait Binding extends QueueDefinition[Abstract] with ExchangeDefinition[Abstract]

   

2. case class ConnectionParams(hosts: Seq[Address] = ..., username: String = ConnectionFactory.DEFAULT_USER, password: String = ConnectionFactory.DEFAULT_PASS, virtualHost: String = ConnectionFactory.DEFAULT_VHOST, ssl: Boolean = false, clientProperties: Map[String, AnyRef] = Map.empty[String, Object], connectionTimeout: Int = 10000, exceptionHandler: ExceptionHandler = new DefaultExceptionHandler(), requestedChannelMax: Int = ..., requestedFrameMax: Int = ConnectionFactory.DEFAULT_FRAME_MAX, requestedHeartbeat: Int = ConnectionFactory.DEFAULT_HEARTBEAT, saslConfig: SaslConfig = DefaultSaslConfig.PLAIN, sharedExecutor: Option[ExecutorService] = None, shutdownTimeout: Int = ..., socketFactory: SocketFactory = SocketFactory.getDefault) extends Product with Serializable

   

   Because topology recovery strategy configuration is crucial to how op-rabbit works, we don't allow some options to be specified

   Because topology recovery strategy configuration is crucial to how op-rabbit works, we don't allow some options to be specified

   Modeling the allowed options via a case-class allows the compiler to tell the library user which options aren't allowed.

3. case class Delivery(consumerTag: String, envelope: Envelope, properties: BasicProperties, body: Array[Byte]) extends Product with Serializable

   

   Represents a message delivery for usage in consumers / Handlers.

4. type Deserialized[T] = Either[ExtractRejection, T]

   

5. trait Deserializer[A, B] extends (A) ⇒ Deserialized[B]

   

6. abstract class Directive[+L <: HList] extends AnyRef

   

7. type Directive1[T] = Directive[::[T, HNil]]

   

8. trait Directives extends AnyRef

   

   Directives power the declarative DSL of op-rabbit.

   Directives power the declarative DSL of op-rabbit.

   In order to define a consumer, you need a channel directive, a consumer directive, and one or more extractor directives. For example:

   channel(qos = 3) {
     consume(queue("my.queue.name")) {
       (body(as[MyPayloadType]) & optionalProperty(ReplyTo) & optionalProperty(Priority)) { (myPayload, replyTo, priority) =>
         // work ...
         ack
       }
     }
   }

   As seen, directives are composable via &. In the end, the directive is applied with a function whose parameters match the output values from the directive(s).

   One value of the directives, as opposed to accessing the AMQP properties directly, is that they are type safe, and care was taken to reduce the probability of surprise. Death is swiftly issued to null and Object. Some directives, such as property, will nack the message if the value specified can't be extracted; IE it is null. If you'd prefer to use a default value instead of nacking the message, you can specify alternative values using | provide(...).

   (property(ReplyTo) | provide("default-reply-to") { replyTo =>
     // ...
   }

   Note: the directives themselves don't actually do anything, except when applied / returned. IE:

   channel(qos = 3) {
     consume(queue("my.queue.name")) {
       property(ReplyTo) // does absolutely nothing
   
       body(as[MyPayloadType]) { (myPayload, replyTo, priority) =>
         ack // this ack here does absolutely nothing (not the return value)
         // work ...
         ack
       }
     }
   }

9. trait Exchange[+T <: op_rabbit.Exchange.Value] extends ExchangeDefinition[Concrete]

   

   Common interface for how exchanges are defined.

   Common interface for how exchanges are defined.

   See:

   • Exchange object for various factory definitions.
   • Exchange.ModeledArgs

10. case class GenericMarshallingException(message: String) extends MarshallingException with Product with Serializable

    

11. type Handler = (Promise[ReceiveResult], Delivery) ⇒ Unit

    

12. case class InvalidFormat(received: String, error: String) extends MarshallingException with Product with Serializable

    

    This exception is thrown when a RabbitUnmarshaller tries to unmarshall a message with the wrong contentType specified in the header.

13. sealed abstract class MarshallingException extends Exception

    

14. final class Message extends MessageForPublicationLike

    

    Confirmed Message container.

    Confirmed Message container. Send to RabbitControl actor for delivery. Upon delivery confirmation, RabbitControl will respond to the sender with true.

    Use the factory method Message$.apply to instantiate one of these using an implicit RabbitMarshaller for serialization.

    See also

    Message$.exchange, Message$.topic, Message$.queue

15. trait MessageForPublicationLike extends (Channel) ⇒ Unit

    

    Basic interface; send to RabbitControl actor for delivery.

16. case class MismatchedContentType(received: String, expected: String) extends MarshallingException with Product with Serializable

    

    This exception is thrown when a RabbitUnmarshaller tries to unmarshall a message with the wrong contentType specified in the header.

17. trait Publisher extends AnyRef

    

18. class RabbitControl extends Actor with ActorLogging with Stash

    

    RabbitControl is the top-level actor which handles the following:

    Overview

    RabbitControl is the top-level actor which handles the following:

    - Pull configuration from the rabbitmq config block, and establish connection to RabbitMQ - Manage subscriptions

    Messages received

    RabbitControl accepts the following commands / queries:

    • MessageForPublicationLike - Publish the given message
    • RabbitControl.SubscriptionCommand - Pause / Resume all register subscriptions (consumers)
    • RabbitControl.GetConnectionActor - Return the akka.actor.ActorRef for the akka-rabbitmq ConnectionActor
    • Subscription - Activate the given subscription; responds with a SubscriptionRef

19. trait RabbitErrorLogging extends AnyRef

    

    Basic trait for reporting error messages; implement to build your own error reporting strategies to be used with consumers

20. trait RabbitMarshaller[T] extends AnyRef

    

    This trait is used to serialize messages for publication; it configures a property builder and sets the appropriate headers

    This trait is used to serialize messages for publication; it configures a property builder and sets the appropriate headers

    See also

    RabbitUnmarshaller, UTF8StringMarshaller, BinaryMarshaller

21. trait RabbitUnmarshaller[T] extends AnyRef

    

    This trait is used to deserialize messages from binary format for use in Consumers; it checks and honors the contentType / encoding message headers, as appropriate.

    This trait is used to deserialize messages from binary format for use in Consumers; it checks and honors the contentType / encoding message headers, as appropriate.

    See also

    RabbitMarshaller, UTF8StringMarshaller, BinaryMarshaller

22. sealed trait ReceiveResult extends AnyRef

    

23. trait RecoveryStrategy extends (String, Channel, Throwable) ⇒ Handler

    

    Instructs RabbitMQ what to do in the event of a consumer failure, failure being defined as the handler throwing an exception, the fail directive being used, or ack(Future.failed(ex)) / ack(Failure(ex)).

    Instructs RabbitMQ what to do in the event of a consumer failure, failure being defined as the handler throwing an exception, the fail directive being used, or ack(Future.failed(ex)) / ack(Failure(ex)).

    By contract, RecoveryStrategy accept a queueName, channel, and exception, and return a Handler whose status dictates the fate of the recovered message. A RecoveryStratregy should not do any asynchronous work involving the provided channel

24. sealed trait Rejection extends Exception

    

25. class StatusCheckMessage extends MessageForPublicationLike

    

    Send this message to RabbitControl to check the status of our connection to the RabbitMQ broker.

26. class Subscription extends Directives

    

    A Subscription contains a full definition for a consumer (channel, binding, handling, error recovery, reportings, etc.) subscription

    A Subscription contains a full definition for a consumer (channel, binding, handling, error recovery, reportings, etc.) subscription

    This object is sent to RabbitControl to boot.

    Example instantiation:

    Subscription { import Directives._

    channel(qos = 1) { consume(queue("such-queue")) { body(as[String]) { payload => // do work... ack } } } }

27. trait SubscriptionRef extends AnyRef

    

28. class TopicMatcher extends AnyRef

    

29. class TypeHolder[T] extends AnyRef

    

    Attributes

    protected

30. final class UnconfirmedMessage extends MessageForPublicationLike