IronMqClient

Instance Constructors

new IronMqClient(settings: IronMqSettings)(implicit actorSystem: ActorSystem, materializer: Materializer)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearMessages(queueName: Name)(implicit ec: ExecutionContext): Future[Unit]

Purge a queue, removing all messages from it.
Purge a queue, removing all messages from it.
WARNING: It will delete ALL messages from a Queue.
queueName
The queue to be purged.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createQueue(name: Name)(implicit ec: ExecutionContext): Future[Queue]

Create a new queue, with default parameters, with the given name.
def deleteMessages(queueName: Name, reservations: Reservation*)(implicit ec: ExecutionContext): Future[Unit]

This will delete previously reserved messages.
This will delete previously reserved messages.
queueName
The queue to delete messages from.
reservations
The reservations to be used to delete messages. They should not be already expired.
def deleteQueue(name: Name)(implicit ec: ExecutionContext): Future[Done]

Delete the queue with the given name.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listQueues(prefix: Option[String] = None, from: Option[Name] = None, noOfQueues: Int = 50)(implicit ec: ExecutionContext): Future[Traversable[Name]]

List the available queues.
List the available queues.
It support pagination by providing the last queue name and number of desired results. It can also filter by queue name prefix.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def peekMessages(queueName: Name, numberOfMessages: Int = 1)(implicit ec: ExecutionContext): Future[Iterable[Message]]

It will fetch a number of messages without reserving or deleting them.
It will fetch a number of messages without reserving or deleting them. It is mainly ussed to monitor or inspect a queue.
queueName
The name of the queue to fetch the messages from.
numberOfMessages
The maximum number of the messages to fetch.
def pullMessages(queueName: Name, noOfMessages: Int = 1, watch: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Iterable[Message]]

Consume a number of messages from the given queue.
Consume a number of messages from the given queue.
The messages will not be available anymore to any other consumer. They are deleted immediately after being fetched.
queueName
The name of the queue to consume from.
noOfMessages
The maximum number of messages to consume (It will return a number of messages up to this number)
watch
The amount of time the consumer will wait for more messages to be consumed.
def pushMessages(queueName: Name, messages: PushMessage*)(implicit ec: ExecutionContext): Future[Ids]

Produce the given messages to the queue with the given name.
Produce the given messages to the queue with the given name. Return the ids ot the produced messages.
def releaseMessage(queueName: Name, reservation: Reservation, delay: FiniteDuration = Duration.Zero)(implicit ec: ExecutionContext): Future[Unit]

This will release a previously reserved message.
This will release a previously reserved message.
queueName
The queue to relesse messages from.
reservation
The reservations to be used to release messages. It should not be already expired.
delay
How much time before the message will be available to other consumers.
def reserveMessages(queueName: Name, noOfMessages: Int = 1, timeout: Duration = Duration.Undefined, watch: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Iterable[ReservedMessage]]

Reserve a number of messages from the given queue.
Reserve a number of messages from the given queue.
When a message has been reserved, it is not available to other consumer for the time specified by the timeout argument.
queueName
The name of the queue to reserve from.
noOfMessages
The maximum number of messages to reserve (It will return a number of messages up to this number)
timeout
The reservation timeout. After this time the reserved message is put back in the queue.
watch
The amount of time the consumer will wait for more messages to be reserved.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def touchMessage(queueName: Name, reservation: Reservation, timeout: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Reservation]

This will renew a nearly expired reservation.
This will renew a nearly expired reservation. It is used to extend the reservation period.
queueName
The name of the queue to renew the reservation from.
reservation
The Reservation to be renewed.
timeout
The new reservation timeout.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object IronMqClient | package ironmq

class IronMqClient extends AnyRef

Instance Constructors

new IronMqClient(settings: IronMqSettings)(implicit actorSystem: ActorSystem, materializer: Materializer)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clearMessages(queueName: Name)(implicit ec: ExecutionContext): Future[Unit]

def clone(): AnyRef

def createQueue(name: Name)(implicit ec: ExecutionContext): Future[Queue]

def deleteMessages(queueName: Name, reservations: Reservation*)(implicit ec: ExecutionContext): Future[Unit]

def deleteQueue(name: Name)(implicit ec: ExecutionContext): Future[Done]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def listQueues(prefix: Option[String] = None, from: Option[Name] = None, noOfQueues: Int = 50)(implicit ec: ExecutionContext): Future[Traversable[Name]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def peekMessages(queueName: Name, numberOfMessages: Int = 1)(implicit ec: ExecutionContext): Future[Iterable[Message]]

def pullMessages(queueName: Name, noOfMessages: Int = 1, watch: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Iterable[Message]]

def pushMessages(queueName: Name, messages: PushMessage*)(implicit ec: ExecutionContext): Future[Ids]

def releaseMessage(queueName: Name, reservation: Reservation, delay: FiniteDuration = Duration.Zero)(implicit ec: ExecutionContext): Future[Unit]

def reserveMessages(queueName: Name, noOfMessages: Int = 1, timeout: Duration = Duration.Undefined, watch: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Iterable[ReservedMessage]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def touchMessage(queueName: Name, reservation: Reservation, timeout: Duration = Duration.Undefined)(implicit ec: ExecutionContext): Future[Reservation]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped