The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
IO-Iron-0.12_01
River stage one • 2 direct dependents • 2 total dependents
++
/ IO::Iron::IronMQ::Queue

NAME

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

VERSION

version 0.12_01

SYNOPSIS

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

REQUIREMENTS

SUBROUTINES/METHODS

new

Creator function.

size

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

post_messages

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

reserve_messages

Params: n (number of messages). default 1, timeout (timeout for message processing in the user program, default: queue value), wait (Time to long poll for messages, in seconds. Max is 30 seconds. Default 0.), delete (If true, do not put each message back on to the queue after reserving. Default false)
Return: list of IO::Iron::IronMQ::Message objects, empty list if no messages available.

peek_messages

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

delete_message

Params: one IO::Iron::IronMQ::Message object.
Return: [NONE]

delete_messages

Params: one or more messages (IO::Iron::IronMQ::Message).
Return: undefined.

touch_message

Changes the reservation_id of the parameter IO::Iron::IronMQ::Message object.

Params: IO::Iron::IronMQ::Message object.
Return: undefined

release_message

Params: IO::Iron::IronMQ::Message.
Return: undefined

clear_messages

Params: [None].
Return: undefined.

get_push_statuses

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

Getters/setters

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

name Message queue name.
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@iki.fi>

BUGS

Please report any bugs or feature requests to bug-io-iron@rt.cpan.org or through the web interface at: http://rt.cpan.org/Public/Dist/Display.html?Name=IO-Iron

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Mikko Koivunalho.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.