Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package leonard
    Definition Classes
    io
  • package amqp

    Scala wrapper for interacting with AMQP, the aim is for convenient: - scala style usage - RPC calls - event hooks - reconnection strategies - message creation and extraction for common message types

    Scala wrapper for interacting with AMQP, the aim is for convenient: - scala style usage - RPC calls - event hooks - reconnection strategies - message creation and extraction for common message types

    Overview

    Build connections with io.leonard.amqp.ConnectionHolder.builder

    Create a connection:

    val connection = ConnectionHolder.builder("amqps://guest:password@host:port")
      .eventHooks(EventHooks(eventListener))
      .reconnectionStrategy(ReconnectionStrategy.JavaClientFixedReconnectDelay(1 second))
      .build()

    Create a channel:

    val channel = connection.newChannel()

    Create an RPC server listening on queue "queue.name", expecting a String and echoing it back:

    def rpcHandler(request: Message): Future[Message] = request match {
      case Message.String(string) => Future(Message.String(string))
    }
    val queue = QueueDeclare(Some("queue.name"))
    val rpcServerCloser = channel.rpcServer(queue, AckOnHandled)(rpcHandler)

    Create an RPC client method which sends requests to the queue "queue.name" with a response timeout of 10 seconds :

    val rpcClient = RPCClient(channel)
    val rpcMethod = rpcClient.newMethod(Exchange.Default.route("queue.name"), 10 second)

    Create a consumer on "queue.name" printing out strings sent to it:

    def consumer(request: Message): Unit = request match {
      case Message.String(string) => println(string)
    }
    val queue = QueueDeclare(Some("queue.name"))
    channel.addConsumer(queue, consumer)

    Send a message to "queue.name":

    channel.send(Exchange.Default.route("queue.name"), Message.String("message")
    Definition Classes
    leonard
  • package concurrent
    Definition Classes
    amqp
  • package connection
    Definition Classes
    amqp
  • package properties
    Definition Classes
    amqp
  • package rpc
    Definition Classes
    amqp
  • ByteArray
  • ChannelOwner
  • Closeable
  • ConnectionHolder
  • ConnectionHolderBuilder
  • DeliveryMode
  • Envelope
  • Event
  • EventHooks
  • Exchange
  • ExchangeType
  • ManualAcker
  • Message
  • MessageProperties
  • Publish
  • Queue
  • QueueDeclare
  • QueuePassive
  • RPCClient
  • RPCMethod
  • ReconnectionStrategy
  • RoutingDescriptor
  • RpcServerAutoAckMode
  • ToMessage
  • UndeliveredException
c

io.leonard.amqp

RoutingDescriptor

case class RoutingDescriptor(exchange: Exchange, routingKey: String, deliveryMode: Option[DeliveryMode], mandatory: Boolean, immediate: Boolean) extends Product with Serializable

Specifies routing and send parameters

exchange

for the message to be sent to

routingKey

the exchange uses this to decide which queue(s) the message is to be added to

deliveryMode

defines whether a message should be persisted if the queue it is on is persisted

mandatory

a message with this flag will be returned by the exchange if it finds that no queues match the routingKey

immediate

a message with this flag will only be delivered if a matching queue has a ready consumer, if not it is returned

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RoutingDescriptor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RoutingDescriptor(exchange: Exchange, routingKey: String, deliveryMode: Option[DeliveryMode], mandatory: Boolean, immediate: Boolean)

    exchange

    for the message to be sent to

    routingKey

    the exchange uses this to decide which queue(s) the message is to be added to

    deliveryMode

    defines whether a message should be persisted if the queue it is on is persisted

    mandatory

    a message with this flag will be returned by the exchange if it finds that no queues match the routingKey

    immediate

    a message with this flag will only be delivered if a matching queue has a ready consumer, if not it is returned

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. val deliveryMode: Option[DeliveryMode]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val exchange: Exchange
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. val immediate: Boolean
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val mandatory: Boolean
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. val routingKey: String
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped