op_rabbit

Type Members

class AirbrakeLogger extends RabbitErrorLogging

To use this package, you must add 'op-rabbit-airbrake' to your dependencies.
BATTERIES NOT INCLUDED
To use this package, you must add 'op-rabbit-airbrake' to your dependencies.
Overview
Instantiates a new RabbitErrorLogging strategy that reports exceptions, along with message and message headers, to Airbrake.
Instantiating from config
Call the convenience lazy-getter AirBrake.fromConfig to get a AirbrakeLogger initialize from application configuration, which should be formatted as follows:
```
airbrake {
  app-name = "my-awesome-app"
  key = "deadbeefdeadbeefdeadbeefdeadbeef"
  environment = "production"
}
```
trait Binding extends QueueDefinition[Abstract] with ExchangeDefinition[Abstract]
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.
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.
type Deserialized[T] = Either[ExtractRejection, T]
trait Deserializer[A, B] extends (A) ⇒ Deserialized[B]
abstract class Directive[+L <: HList] extends AnyRef
type Directive1[T] = Directive[::[T, HNil]]
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
    }
  }
}
```
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
case class GenericMarshallingException(message: String) extends MarshallingException with Product with Serializable
type Handler = (Promise[ReceiveResult], Delivery) ⇒ Unit
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.
sealed abstract class MarshallingException extends Exception
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
trait MessageForPublicationLike extends (Channel) ⇒ Unit

Basic interface; send to RabbitControl actor for delivery.
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.
trait Publisher extends AnyRef
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
trait RabbitErrorLogging extends AnyRef

Basic trait for reporting error messages; implement to build your own error reporting strategies to be used with consumers
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
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
sealed trait ReceiveResult extends AnyRef
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
sealed trait Rejection extends Exception
class StatusCheckMessage extends MessageForPublicationLike

Send this message to RabbitControl to check the status of our connection to the RabbitMQ broker.
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 } } } }
trait SubscriptionRef extends AnyRef
class TopicMatcher extends AnyRef
class TypeHolder[T] extends AnyRef

Attributes
protected
final class UnconfirmedMessage extends MessageForPublicationLike

Value Members

object AirbrakeLogger

See also
AirbrakeLogger
object BinaryMarshaller extends RabbitMarshaller[Array[Byte]] with RabbitUnmarshaller[Array[Byte]]

Pull binary message payload raw, without any serialization.
Pull binary message payload raw, without any serialization. An implicit is defined in RabbitUnmarshaller$.binaryUnmarshaller and RabbitMarshaller$.binaryUnmarshaller
object Binding
object CirceSupport
object ConnectionParams extends Serializable
object Deserializer extends DeserializerLowerPriorityImplicits
object Directive
object Directives extends Directives

Convenience object and recommended way for bringing the directives in scope.
Convenience object and recommended way for bringing the directives in scope. See Directives trait.
object Exchange extends Enumeration
object Json4sSupport

To use this package, you must add 'op-rabbit-json4s' to your dependencies.
BATTERIES NOT INCLUDED
To use this package, you must add 'op-rabbit-json4s' to your dependencies.
Using
If using json4s-native, import Json4sSupport.native._
If using json4s-jackson, import Json4sSupport.jackson._
object Message extends MessageFactory[Message]

Confirmed message generator.
Confirmed message generator. See Message$
object MessageForPublicationLike
object ModeledConsumerArgs
object ModeledMessageHeaders

object PlayJsonSupport

To use this package, you must add 'op-rabbit-play-json' to your dependencies.

BATTERIES NOT INCLUDED

To use this package, you must add 'op-rabbit-play-json' to your dependencies.

Overview

Use implicit PlayJson formats for serialization by importing this object.

Example:

import play.api.libs.json._
import com.spingo.op_rabbit.PlayJsonSupport._

object Example {
  case class Person(name: String, age: Int)
  implicit val format = Json.format[Person]
  // Both of these can be implicitly created:
  // - implicitly[RabbitMarshaller[Person]]
  // - implicitly[RabbitUnmarshaller[Person]]
  val consumer = AsyncAckingConsumer[Person]("PurplePeopleEater") { person =>
    Future { eat(person) }
  }
  val message = QueueMessage(Person("Bill", 25), "people-for-consumption")
}

object Publisher
object Queue
object RabbitConfig
object RabbitControl
object RabbitErrorLogging
object RabbitExceptionMatchers
object RabbitHelpers
object RabbitMarshaller
object RabbitUnmarshaller
object ReceiveResult
object RecoveryStrategy
object Rejection extends Serializable
object Slf4jLogger extends RabbitErrorLogging

Reports consumer errors to Slf4j.

object SprayJsonSupport

To use this package, you must add 'op-rabbit-spray-json' to your dependencies.

BATTERIES NOT INCLUDED

To use this package, you must add 'op-rabbit-spray-json' to your dependencies.

Overview

Use implicit SprayJson formats for serialization by importing this object.

Example:

import spray.json.DefaultJsonProtocol
import com.spingo.op_rabbit.SprayJsonSupport._

object Example extends DefaultJsonProtocol {
  case class Person(name: String, age: Int)
  implicit val format = jsonFormat2(Person)
  // Both of these can be implicitly created:
  // - implicitly[RabbitMarshaller[Person]]
  // - implicitly[RabbitUnmarshaller[Person]]
  val consumer = AsyncAckingConsumer[Person]("PurplePeopleEater") { person =>
    Future { eat(person) }
  }
  val message = QueueMessage(Person("Bill", 25), "people-for-consumption")
}

object StatusCheckMessage
object Subscription
object SubscriptionActor
object TopicMatcher
object TypeHolder

Attributes
protected
object UTF8StringMarshaller extends RabbitMarshaller[String] with RabbitUnmarshaller[String]

Converts binary message to a UTF8 string, and back.
Converts binary message to a UTF8 string, and back. An implicit is defined in RabbitUnmarshaller$.stringMarshaller and RabbitMarshaller$.stringMarshaller
object UnconfirmedMessage extends MessageFactory[UnconfirmedMessage]
val futureUnit: Future[Unit]

Attributes
protected
package properties
package stream

To use this package, you must add 'op-rabbit-akka-stream' to your dependencies.
Batteries not included
To use this package, you must add 'op-rabbit-akka-stream' to your dependencies.
Overview

See also
Akka Stream Specs on GitHub

Deprecated Value Members

object LogbackLogger extends RabbitErrorLogging

Annotations
@deprecated
Deprecated
(Since version 1.0.2) LogbackLogger has been renamed to Slf4jLogger

package op_rabbit

Type Members

class AirbrakeLogger extends RabbitErrorLogging

BATTERIES NOT INCLUDED

Overview

Instantiating from config

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

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

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

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

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

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

trait Directives extends AnyRef

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

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

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

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

sealed abstract class MarshallingException extends Exception

final class Message extends MessageForPublicationLike

trait MessageForPublicationLike extends (Channel) ⇒ Unit

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

trait Publisher extends AnyRef

class RabbitControl extends Actor with ActorLogging with Stash

Overview

Messages received

trait RabbitErrorLogging extends AnyRef

trait RabbitMarshaller[T] extends AnyRef

trait RabbitUnmarshaller[T] extends AnyRef

sealed trait ReceiveResult extends AnyRef

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

sealed trait Rejection extends Exception

class StatusCheckMessage extends MessageForPublicationLike

class Subscription extends Directives

trait SubscriptionRef extends AnyRef

class TopicMatcher extends AnyRef

class TypeHolder[T] extends AnyRef

final class UnconfirmedMessage extends MessageForPublicationLike

Value Members

object AirbrakeLogger

object BinaryMarshaller extends RabbitMarshaller[Array[Byte]] with RabbitUnmarshaller[Array[Byte]]

object Binding

object CirceSupport

object ConnectionParams extends Serializable

object Deserializer extends DeserializerLowerPriorityImplicits

object Directive

object Directives extends Directives

object Exchange extends Enumeration

object Json4sSupport

BATTERIES NOT INCLUDED

Using

object Message extends MessageFactory[Message]

object MessageForPublicationLike

object ModeledConsumerArgs

object ModeledMessageHeaders

object PlayJsonSupport

BATTERIES NOT INCLUDED

Overview

object Publisher

object Queue

object RabbitConfig

object RabbitControl

object RabbitErrorLogging

object RabbitExceptionMatchers

object RabbitHelpers

object RabbitMarshaller

object RabbitUnmarshaller

object ReceiveResult

object RecoveryStrategy

object Rejection extends Serializable

object Slf4jLogger extends RabbitErrorLogging

object SprayJsonSupport

BATTERIES NOT INCLUDED

Overview

object StatusCheckMessage

object Subscription

object SubscriptionActor

object TopicMatcher

object TypeHolder

object UTF8StringMarshaller extends RabbitMarshaller[String] with RabbitUnmarshaller[String]