IronMQ v3 Glossary

Table of Contents

body - The data of the message being pushed or pulled

Clear Messages - This endpoint will remove all messages from a queue

dead_letter - A queue that other (source) queues can target to send messages that for some reason could not be successfully processed. A primary benefit of using a dead letter queue is the ability to sideline and isolate the unsuccessfully processed messages

delay - The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. Maximum is 604,800 seconds (7 days)

delete - Removal of message and it’s reservation ID

error_queue - The name of another queue where information about messages that can't be delivered after retrying retries number of times will be placed. Please note, error queue will not appear in the until first error occurs

max_reservations - This is used on conjunction with a dead letter queue to limit the amount of messages that can be placed in it. The default is 10

message_expiration - The amount of time a message will live on the queue

message_timeout - How many seconds new reservation will be valid

multicast - An option for Push queues. This is a routing pattern that will push the messages to all the subscribers

n - The maximum number of messages to get. Default is 1. Maximum is 100. Note: You may not receive all n messages on every request, the more sparse the queue, the less likely you are to receive all n messages

per_page - Number of elements in response, default is 30

prefix - An optional queue prefix to search on. e.g., prefix=ca could return queues ["cars", "cats", etc.]

Previous - When listing the queues, this is the last queue on the previous page

Pull Queue - This is the default queue style when creating an IronMQ queue. Pull queues require the client to check in and take message out

push_headers - This is additional information you wish to add to the header of a push queue

queue_name - This is the unique name given to each of your queues

Queue - A queue can be either a multicast or unicast (both push queues) or it can be a pull queue

Release Message - This releases the reservation of a message so it can be used for another process

reservation_id - This id is returned when you reserve a message

reserved_count - Shows the amount of reserved messages in your request

retries_delay - Time in seconds between retries. Default is 60. Minimum is 3 and maximum is 86400 seconds

retries - Number of times to retry. Default is 3. Maximum is 10

subscriber_name - This field could be used in case of push message processing acknowledge. When request from IronMQ Pusher is received, and subscriber endpoint returns HTTP 202 Accepted, message must be acknowledged, otherwise it will be pushed again

Subscriber - These are simply URLs that IronMQ will post to whenever a message is posted to your queue

Timeout - The amount of time given to an endpoint to respond. If the endpoint does not respond within the timeout, it's marked as failed/error and will be retried

total_messages - When getting queue info, this shows the total messages in your query

Touch Message - Extends the timeout period so process can finish processing message

Type - This shows what kind of queue it is. Options are pull, multicast and unicast

Unicast - A queue that will try one endpoint in the set of subscribers. If it succeeds, that message is considered delivered. If it fails, a different endpoint is tried immediately and this continues until a successful response is returned or all endpoints have been tried. If there is no successful response from all endpoints, then the message will be retried after retries_delay

wait - Time to long poll for messages, in seconds. Max is 30 seconds. The default is 0