NAME

IO::Iron::IronCache::Policy - Base package (inherited) for IronCache::Client package.

SYNOPSIS

        # new() in the inheriting sub class.

        sub new {
                my ($class, $params) = @_;
                my $self = IO::Iron::IronCache::Policy->new();
                # Add more keys to the self hash.
                my @self_keys = (
                                'caches',        # References to all objects created of class IO::Iron::IronCache::Cache.
                                legal_keys(%{$self}),
                );
                unlock_keys(%{$self});
                lock_keys_plus(%{$self}, @self_keys);
                my @caches;
                $self->{'caches'} = \@caches;
        
                unlock_keys(%{$self});
                bless $self, $class;
                lock_keys(%{$self}, @self_keys);
        
                return $self;
        }

METHODS

is_cache_name_alternatives

is_item_key_alternatives

cache_name_alternatives

Return all possible cache name alternatives according to the current policy.

[No parameters.]

Return: list of cache name alternatives

Will throw NoIronPolicyException if there is no limit to the alternatives.

item_key_alternatives

Return all possible item key alternatives according to the current policy.

[No parameters.]

Return: list of item key alternatives

Will throw NoIronPolicyException if there is no limit to the alternatives.

is_valid_cache_name

Check if the cache name is valid according to the policy. Return 1/0.

name string to verify.

validate_cache_name

Same as above but if validation fails, throws IronPolicyException. If valid, returns undef.

name string to verify.

is_valid_item_key

Check if the item key is valid according to the policy. Return 1/0.

key string to verify.

validate_item_key

Same as above but if validation fails, throws IronPolicyException. If valid, returns undef.

key string to verify.

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::IronCache::Policy

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/

ACKNOWLEDGMENTS

Cool idea, "message queue in the cloud": http://www.iron.io/. And well implemented.

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.

cpanm IO::Iron

perl -MCPAN -e shell
install IO::Iron