Mikko Koivunalho > IO-Iron-0.10 > IO::Iron::IronMQ::Queue

Download:
IO-Iron-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  2
View/Report Bugs
Module Version: 0.10   Source  

NAME ^

IO::Iron::IronMQ::Queue - IronMQ (Online Message Queue) Client (Queue).

VERSION ^

version 0.10

SYNOPSIS ^

Please see IO::Iron::IronMQ::Queue for usage.

REQUIREMENTS ^

SUBROUTINES/METHODS ^

new

Creator function.

push

Params: one or more IO::Iron::IronMQ::Message objects.
Return: message id(s) returned from IronMQ (if in list context), or number of messages.

pull

Params: n (number of messages), timeout (timeout for message processing in the user program)
Return: list of IO::Iron::IronMQ::Message objects, empty list if no messages available.

peek

Params: n, number of messages to read
Return: list of IO::Iron::IronMQ::Message objects, empty list if no messages available.

delete

Params: one or more message ids.
Return: the deleted message ids (if in list context), or the number of messages deleted.

release

Params: Message id.
Return: 1

touch

Params: Message id.
Return: 1 if successful, 0 if failed to touch.

clear

Params: [None].
Return: 1 if successful.

size

Params: [none]
Return: queue size (integer).

get_push_status

Params: id (message id).
Return: a hash containing info, subitem 'subscribers' is an array.

delete_push_message

Params: id (message id), subscriber (subscriber id).
Return: 1 if successful.

Getters/setters

Set or get a property. When setting, returns the reference to the object.

name Message queue name.
id Message queue id.
ironmq_client Reference to the IO::Iron::IronMQ::Client object which instantiated this object.
connection Reference to the Connection object.
last_http_status_code HTTP status code returned by the last call to Iron.io services.

AUTHOR ^

Mikko Koivunalho, <mikko.koivunalho at iki.fi>

BUGS ^

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.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc IO::Iron::IronMQ::Queue

You can also look for information at:

ACKNOWLEDGMENTS ^

LICENSE AND COPYRIGHT ^

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.

syntax highlighting: