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
t

io.leonard.amqp

ChannelOwner

trait ChannelOwner extends AnyRef

Operation to perform on an amqp channel, the underlying connection may fail and be replaced by a new one with the same parameters

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChannelOwner
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addConsumer(queue: Queue, consumer: (Message) ⇒ Unit): Closeable

    Listens on the queue, automatically acknowledging messages and then passing them to the consumer

  2. abstract def addConsumerAckManual(queue: Queue, consumer: (Message, ManualAcker) ⇒ Unit): Closeable

    Listen to a queue, the consumer is responsible for acking the messages

  3. abstract def addEnvelopeConsumer(queue: Queue, consumer: (Envelope) ⇒ Unit): Closeable

    Listens on the queue, automatically acknowledging messages and then passing them to the consumer

  4. abstract def addEnvelopeConsumerAckManual(queue: Queue, consumer: (Envelope, ManualAcker) ⇒ Unit): Closeable

    Listen to a queue, the consumer is responsible for acking the messages

  5. abstract def close(): Unit
  6. abstract def declareExchange(name: String, exchangeType: ExchangeType, durable: Boolean = false, autoDelete: Boolean = false, args: Map[String, AnyRef] = Map.empty): Exchange
  7. abstract def declareExchangePassive(name: String): Exchange
  8. abstract def declareQueue(queue: Queue): String
  9. abstract def queueBind(queue: QueuePassive, exchange: Exchange, routingKey: String): Unit
  10. abstract def rpcServer(listenQueue: Queue, ackMode: RpcServerAutoAckMode, responseParameters: ResponseParameters = ...)(handler: (Message) ⇒ Future[Message])(implicit ec: ExecutionContext): Closeable

    Adds a handler to respond to RPCs on a particular binding

  11. abstract def send(routingDescriptor: RoutingDescriptor, message: Message): Unit

    Sends a message over this channel

    Sends a message over this channel

    routingDescriptor

    describes how the Message will be routed, including, exchange, routing key and routing flags

    message

    Message to send with properties and headers

  12. abstract def send(routingDescriptor: RoutingDescriptor, message: Message, onReturn: () ⇒ Unit, returnTimeout: FiniteDuration): Unit

    Sends a message over this channel

    Sends a message over this channel

    routingDescriptor

    describes how the Message will be routed, including, exchange, routing key and routing flags

    message

    Message to send with properties and headers

    onReturn

    callback in case message is returned undelivered

    returnTimeout

    duration within which a return would be expected, messages returned after this time will not cause a callback

Concrete 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def sendPublish(publish: Publish): Unit
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped