package IO::Iron::IronMQ::Message;
## no critic (Documentation::RequirePodAtEnd)
## no critic (Documentation::RequirePodSections)
## no critic (Subroutines::RequireArgUnpacking)
use 5.010_000;
use strict;
use warnings;
# Global creator
BEGIN {
}
# Global destructor
END {
}
=for stopwords IronMQ UNDEF Mikko Koivunalho perldoc CPAN AnnoCPAN tradename
=for stopwords licensable MERCHANTABILITY
=head1 NAME
IO::Iron::IronMQ::Message - IronMQ (Online Message Queue) Client (Message).
=cut
our $VERSION = '0.12'; # VERSION: generated by DZP::OurPkgVersion
=head1 SYNOPSIS
Please see IO::Iron::IronMQ::Client for usage.
=head1 REQUIREMENTS
=cut
use Log::Any qw($log);
use Hash::Util 0.06 qw{lock_keys unlock_keys};
use Carp::Assert::More;
use English '-no_match_vars';
use Params::Validate qw(:all);
# CONSTANTS for this module
# DEFAULTS
=head1 SUBROUTINES/METHODS
=head2 new
Creator function.
UNDEF values not accepted.
body is mandatory; delay and push_headers are optional.
id, reserved_count and reservation_id are for internal use.
=cut
sub new {
my $class = shift;
my %params = validate(
@_, {
'body' => { type => SCALAR, }, # Message body (free text), can be empty.
'delay' => { type => SCALAR, optional => 1, }, # The item will not be available on the queue until this many seconds have passed.
'push_headers' => { type => HASHREF, optional => 1, }, # Headers for push queues.
'id' => { type => SCALAR, optional => 1, }, # Message id from IronMQ queue (after message has been reserved/peeked).
'reserved_count' => { type => SCALAR, optional => 1, }, # FIXME item reserved_count
'reservation_id' => { type => SCALAR, optional => 1, }, # Reservation id string from the queue.
}
);
$log->tracef('Entering new(%s, %s)', $class, %params);
my $self;
my @self_keys = ( ## no critic (CodeLayout::ProhibitQuotedWordLists)
'body', # Message body (free text), can be empty.
'delay', # The item will not be available on the queue until this many seconds have passed.
'push_headers', # Push queue headers.
'id', # Message id from IronMQ queue (after message has been pulled/peeked).
'reserved_count', # FIXME item reserved_count
'reservation_id', # reservation_id
);
lock_keys(%{$self}, @self_keys);
$self->{'body'} = $params{'body'};
$self->{'delay'} = defined $params{'delay'} ? $params{'delay'} : undef;
$self->{'push_headers'} = defined $params{'push_headers'} ? $params{'push_headers'} : undef;
$self->{'id'} = defined $params{'id'} ? $params{'id'} : undef;
$self->{'reserved_count'} = defined $params{'reserved_count'} ? $params{'reserved_count'} : undef;
$self->{'reservation_id'} = defined $params{'reservation_id'} ? $params{'reservation_id'} : undef;
# All of the above can be undefined, except the body: the message can not be empty.
# If delay is undefined, the IronMQ defaults (at the server) will be used.
unlock_keys(%{$self});
my $blessed_ref = bless $self, $class;
lock_keys(%{$self}, @self_keys);
$log->tracef('Exiting new: %s', $blessed_ref);
return $blessed_ref;
}
=head2 Getters/setters
Set or get a property.
When setting, returns the reference to the object.
=over 8
=item body Message body (free text), can be empty.
=item delay The item will not be available on the queue until this many seconds have passed.
=item push_headers Push queue HTTP headers.
=item id Message id from IronMQ queue (after message has been pulled/peeked).
=item reserved_count Item reserved count.
=item reservation_id Reservation id string from the queue.
=back
=cut
sub body { return $_[0]->_access_internal('body', $_[1]); }
sub delay { return $_[0]->_access_internal('delay', $_[1]); }
sub push_headers { return $_[0]->_access_internal('push_headers', $_[1]); }
sub id { return $_[0]->_access_internal('id', $_[1]); }
sub reserved_count { return $_[0]->_access_internal('reserved_count', $_[1]); }
sub reservation_id { return $_[0]->_access_internal('reservation_id', $_[1]); }
# TODO Move _access_internal() to IO::Iron::Common.
sub _access_internal {
my ($self, $var_name, $var_value) = @_;
$log->tracef('_access_internal(%s, %s)', $var_name, $var_value);
if( defined $var_value ) {
$self->{$var_name} = $var_value;
return $self;
}
else {
return $self->{$var_name};
}
}
=head1 AUTHOR
Mikko Koivunalho, C<< <mikko.koivunalho at iki.fi> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-io-iron at rt.cpan.org>, or through
the web interface at L<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.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc IO::Iron::IronMQ
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=IO-Iron>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/IO-Iron>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/IO-Iron>
=item * Search CPAN
L<http://search.cpan.org/dist/IO-Iron/>
=back
=head1 ACKNOWLEDGMENTS
=head1 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:
L<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.
=cut
1; # End of IO::Iron::IronMQ::Message