Skip to content

Latest commit

 

History

History
440 lines (299 loc) · 9.85 KB

README.md

File metadata and controls

440 lines (299 loc) · 9.85 KB
Raw

IronMQ PHP Client Library

IronMQ is an elastic message queue for managing data and event flow within cloud applications and between systems.

The full API documentation is here and this client tries to stick to the API as much as possible so if you see an option in the API docs, you can use it in the methods below.

Getting Started

Get credentials

To start using iron_mq_php, you need to sign up and get an oauth token.

  1. Go to http://iron.io/ and sign up.
  2. Get an Oauth Token at http://hud.iron.io/tokens

--

Install iron_mq_php

There are two ways to use iron_mq_php:

Using precompiled phar archive

Copy iron_mq.phar to target directory and include it:

<?php
require_once "phar://iron_mq.phar";

Please note, phar extension available by default only from php 5.3.0 For php 5.2 you should install phar manually or use second option.

Using classes directly
  1. Copy IronMQ.class.php to target directory
  2. Grab IronCore.class.php there and copy to target directory
  3. Include both of them:
<?php
require_once "IronCore.class.php"
require_once "IronMQ.class.php"

--

Configure

Three ways to configure IronMQ:

  • Passing array with options:
<?php
$ironmq = new IronMQ(array(
    "token" => 'XXXXXXXXX',
    "project_id" => 'XXXXXXXXX'
));
  • Passing ini file name which stores your configuration options. Rename sample_config.ini to config.ini and include your Iron.io credentials (token and project_id):
<?php
$ironmq = new IronMQ('config.ini');

  • Automatic config search - pass zero arguments to constructor and library will try to find config file in following locations:

    • iron.ini in current directory
    • iron.json in current directory
    • IRON_MQ_TOKEN, IRON_MQ_PROJECT_ID and other environment variables
    • IRON_TOKEN, IRON_PROJECT_ID and other environment variables
    • .iron.ini in user's home directory
    • .iron.json in user's home directory

--

The Basics

Post a Message to the Queue

<?php
$ironmq->postMessage($queue_name, "Hello world");

More complex example:

<?php
$ironmq->postMessage($queue_name, "Test Message", array(
    "timeout" => 120, # Timeout, in seconds. After timeout, item will be placed back on queue. Defaults to 60.
    "delay" => 5, # The item will not be available on the queue until this many seconds have passed. Defaults to 0.
    "expires_in" => 2*24*3600 # How long, in seconds, to keep the item on the queue before it is deleted.
));

Post multiple messages in one API call:

<?php
$ironmq->postMessages($queue_name, array("Message 1", "Message 2"), array(
    "timeout" => 120
));

--

Get a Message off the Queue

<?php
$ironmq->getMessage($queue_name);

When you pop/get a message from the queue, it will NOT be deleted. It will eventually go back onto the queue after a timeout if you don't delete it (default timeout is 60 seconds).

--

Delete a Message from the Queue

<?php
$ironmq->deleteMessage($queue_name, $message_id);

Delete a message from the queue when you're done with it.

--

Troubleshooting

http error: 0

If you see Uncaught exception 'Http_Exception' with message 'http error: 0 | ' it most likely caused by misconfigured cURL https sertificates. There are two ways to fix this error:

  1. Disable SSL sertificate verification - add this line after IronMQ initialization: $ironmq->ssl_verifypeer = false;
  2. Switch to http protocol - add this to configuration options: protocol = http and port = 80

--

Updating notes

  • 1.3.0 - changed argument list in methods postMessage and postMessages. Please revise code that uses these methods.
  • 1.4.5 - added getMessagePushStatuses and deleteMessagePushStatus methods.

--

Queues

IronMQ Client

IronMQ is based on IronCore and provides easy access to the whole IronMQ API.

<?php
$ironmq = new IronMQ(array(
    "token" => 'XXXXXXXXX',
    "project_id" => 'XXXXXXXXX'
));

--

List Queues

<?php
$queues = $ironmq->getQueues($page, $per_page);

Optional parameters:

  • $page: The 0-based page to view. The default is 0.
  • $per_page: The number of queues to return per page. The default is 30, the maximum is 100.
<?php
$queues_page_four = $ironmq->getQueues(3, 20); // get 4th page, 20 queues per page

--

Retrieve Queue Information

<?php
$qinfo = $ironmq->getQueue($queue_name);

--

Delete a Message Queue

<?php
$response = $ironmq->deleteQueue($queue_name);

--

Post Messages to a Queue

Single message:

<?php
$ironmq->postMessage($queue_name, "Test Message", array(
    'timeout' => 120,
    'delay' => 2,
    'expires_in' => 2*24*3600 # 2 days
));

Multiple messages:

<?php
$ironmq->postMessages($queue_name, array("Lorem", "Ipsum"), array(
    "timeout" => 120,
    "delay" => 2,
    "expires_in" => 2*24*3600 # 2 days
));

Optional parameters (3rd, array of key-value pairs):

  • timeout: After timeout (in seconds), item will be placed back onto queue. You must delete the message from the queue to ensure it does not go back onto the queue. Default is 60 seconds. Minimum is 30 seconds. Maximum is 86,400 seconds (24 hours).

  • 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).

  • expires_in: How long in seconds to keep the item on the queue before it is deleted. Default is 604,800 seconds (7 days). Maximum is 2,592,000 seconds (30 days).

--

Get Messages from a Queue

Single message:

<?php
$message = $ironmq->getMessage($queue_name, $timeout);

Multiple messages:

<?php
$message = $ironmq->getMessages($queue_name, $count, $timeout);

Optional parameters:

  • $count: The maximum number of messages to get. Default is 1. Maximum is 100.

  • $timeout: After timeout (in seconds), item will be placed back onto queue. You must delete the message from the queue to ensure it does not go back onto the queue. If not set, value from POST is used. Default is 60 seconds. Minimum is 30 seconds. Maximum is 86,400 seconds (24 hours).

--

Touch a Message on a Queue

Touching a reserved message extends its timeout by the duration specified when the message was created, which is 60 seconds by default.

<?php
$ironmq->touchMessage($queue_name, $message_id);

--

Release Message

<?php
$ironmq->releaseMessage($queue_name, $message_id, $delay);

Optional parameters:

  • $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 a Message from a Queue

<?php
$ironmq->deleteMessage($queue_name, $message_id);

--

Peek Messages from a Queue

Peeking at a queue returns the next messages on the queue, but it does not reserve them.

Single message:

<?php
$message = $ironmq->peekMessage($queue_name);

Multiple messages:

<?php
$messages = $ironmq->peekMessages($queue_name, $count);

--

Clear a Queue

<?php
$ironmq->clearQueue($queue_name);

--

Push Queues

IronMQ push queues allow you to setup a queue that will push to an endpoint, rather than having to poll the endpoint. Here's the announcement for an overview.

Update a Message Queue

<?php
$params = array(
    "push_type" => "multicast",
    "retries" => 5,
    "subscribers" => array(
        array("url" => "http://your.first.cool.endpoint.com/push"),
        array("url" => "http://your.second.cool.endpoint.com/push")
    )
);

$ironmq->updateQueue($queue_name, $params);

The following parameters are all related to Push Queues:

  • subscribers: An array of subscriber hashes containing a “url” field. This set of subscribers will replace the existing subscribers. To add or remove subscribers, see the add subscribers endpoint or the remove subscribers endpoint. See below for example json.
  • push_type: Either multicast to push to all subscribers or unicast to push to one and only one subscriber. Default is multicast.
  • retries: How many times to retry on failure. Default is 3. Maximum is 100.
  • retries_delay: Delay between each retry in seconds. Default is 60.

--

Add/Remove Subscribers on a Queue

Add subscriber to Push Queue:

<?php
$ironmq->addSubscriber($queue_name, array(
    "url" => "http://cool.remote.endpoint.com/push"
));

$ironmq->removeSubscriber($queue_name, array(
    "url" => "http://cool.remote.endpoint.com/push"
));

--

Get Message Push Status

<?php
$response = $ironmq->postMessage('push me!');

$message_id = $response["ids"][0];
$statuses = $ironmq->getMessagePushStatuses($queue_name, $message_id);

Returns an array of subscribers with status.

--

Acknowledge / Delete Message Push Status

<?php
$statuses = $ironmq->getMessagePushStatuses($queue_name, $message_id);

foreach ($statuses as $status) {
    $ironmq->deleteMessagePushStatus($queue_name, $message_id, $status["id"]);
}

--

Revert Queue Back to Pull Queue

If you want to revert you queue just update push_type to "pull".

<?php
$params = array("push_type" => "pull");

$ironmq->updateQueue($queue_name, $params);

--

Further Links

© 2011 - 2013 Iron.io Inc. All Rights Reserved.