IO::Iron - Client Libraries to Iron services IronCache, IronMQ and IronWorker.
Version 0.05
Iron.io libraries are currently being developed so changes in the API are possible.
To run the tests that come with this distribution you need an Iron.io account.
use IO::Iron; use IO::Iron qw{ironcache ironmq ironworker}; use IO::Iron ':all'; my $iron_mq_client = ironmq(); my @iron_mq_queues = $iron_mq_client->get_queues(); my $iron_cache_client = ironcache( config => 'iron_cache.json' ); my @iron_caches = $iron_cache_client->get_caches(); my $iron_worker_client = ironworker( config => 'iron_worker.json' ); my @iron_codes = $iron_worker_client->list_code_packages();
The IO::Iron::* packages require the following packages (in addition to several Perl core packages):
IO::Iron also requires an IronIO account. Three configuration items must be set (others available) before using the functions: project_id, token and host. These can be set in a json file, as environmental variables or as parameters when creating the object.
project_id
token
host
IronCache, IronMQ and IronWorker are cloud based services accessible via a REST API. CPAN Distribution IO::Iron contains Perl clients for accessing them.
[See http://www.iron.io/]
Please see the individual clients for further documentation and usage.
Clients:
Package IO::Iron is only a "convenience" module for quick startup. The three functions provided are ironcache, ironmq and ironworker.
The following parameters can be given to each of them as hash item type parameters. See section SYNOPSIS for an example.
protocol
port
api_version
host_path_prefix
timeout
config
You can also give the parameters in the config file .iron.json or iron.json (in local directory) or as environmental variables. Please read Configuring the Official Client Libraries for further details.
Please read individual client's documentation for using them.
Create an IronCache client object and return it to user.
Create an IronMQ client object and return it to user.
Create an IronWorker client object and return it to user.
Mikko Koivunalho, <mikko.koivunalho at iki.fi>
<mikko.koivunalho at iki.fi>
Please report any bugs or feature requests to bug-io-iron at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IO-Iron. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-io-iron at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc IO::Iron
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=IO-Iron
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/IO-Iron
CPAN Ratings
http://cpanratings.perl.org/d/IO-Iron
Search CPAN
http://search.cpan.org/dist/IO-Iron/
Cool idea, "message queue in the cloud": http://www.iron.io/. And well implemented, too, with webhooks for several functions!
Implement IO::Iron::IronWorker (partly done).
The IronMQ client needs to control the queues, perhaps using semafores.
A buffer mechanism to keep the messages while the IronMQ REST service is unavailable. IO::Iron::IronMQ::ASyncPush?
Implement push queues.
Mock IronMQ for testing.
Handle message size (total), delay, timeout and expiration min-max values.
Message Var Default Maximum Notes
Message Size -- 64KB Includes the entire request (delay, timeout, expiration).
Delay 0sec 604,800sec Message is made available on queue after the delay expires.
Timeout 60sec 86,400sec Message goes back on queue after timeout unless deleted.
Expiration 604,800sec 2,592,000sec Equates to 7 days and 30 days, respectively.
Messages per Get 1 100 One or more messages can be handled at a time.
Option to delete queue when IO::Iron::IronMQ::Queue object goes to garbage collection?
Verify the client is connected when created (by calling queues?)
Rethink the using of REST:Client. Since message queues often involve a lot of traffic but always to the same address, we need to optimize REST:Client usage.
Change from JSON to JSON::Any.
Copyright 2013 Mikko Koivunalho.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
To install IO::Iron, copy and paste the appropriate command in to your terminal.
cpanm
cpanm IO::Iron
CPAN shell
perl -MCPAN -e shell install IO::Iron
For more information on module installation, please visit the detailed CPAN module installation guide.