chi::driver::memcached(3pm) [debian man page]

CHI::Driver::Memcached(3pm)				User Contributed Perl Documentation			       CHI::Driver::Memcached(3pm)

NAME

       CHI::Driver::Memcached -- Distributed cache via memcached (memory cache daemon)

VERSION

       version 0.14

SYNOPSIS

	   use CHI;

	   my $cache = CHI->new(
	       driver => 'Memcached',	# or 'Memcached::Fast', or 'Memcached::libmemcached'
	       namespace => 'products',
	       servers => [ "10.0.0.15:11211", "10.0.0.15:11212", "/var/sock/memcached",
	       "10.0.0.17:11211", [ "10.0.0.17:11211", 3 ] ],
	       debug => 0,
	       compress_threshold => 10_000,
	   );

DESCRIPTION

       A CHI driver that uses Cache::Memcached to store data in the specified memcached server(s).

       CHI::Driver::Memcached::Fast and CHI::Driver::Memcached::libmemcached are also available as part of this distribution. They work with other
       Memcached clients and support a similar feature set. Documentation for all three modules is presented below.

CONSTRUCTOR OPTIONS

       Namespace, appended with ":", is passed along to the Cached::Memcached::* constructor, along with any constructor options not recognized by
       CHI - for example servers, compress_threshold and debug.

       If you need more control over the options passed to Cache::Memcached::*, you may specify a hash directly in "memd_params".

METHODS

       Besides the standard CHI methods:

       memd
	   Returns a handle to the underlying Cache::Memcached::* object. You can use this to call memcached-specific methods that are not
	   supported by the general API, e.g.

	       $self->memd->incr("key");
	       my $stats = $self->memd->stats();

UNSUPPORTED METHODS

       These standard CHI methods cannot currently be supported by memcached, chiefly because there is no way to get a list of stored keys.

       dump_as_hash
       clear
       get_keys
       get_namespaces
       is_empty
       purge

SUPPORT AND DOCUMENTATION

       Questions and feedback are welcome, and should be directed to the perl-cache mailing list:

	   http://groups.google.com/group/perl-cache-discuss

       Bugs and feature requests will be tracked at RT:

	   http://rt.cpan.org/NoAuth/Bugs.html?Dist=CHI-Driver-Memcached

       The latest source code can be browsed and fetched at:

	   http://github.com/jonswar/perl-chi-driver-memcached/tree/master
	   git clone git://github.com/jonswar/perl-chi-driver-memcached.git

AUTHOR

       Jonathan Swartz

SEE ALSO

       CHI, Cache::Memcached, CHI::Driver::Memcached::Fast, CHI::Driver::Memcached::libmemcached

COPYRIGHT &; LICENSE
       Copyright (C) 2007 Jonathan Swartz.

       CHI::Driver::Memcached is provided "as is" and without any express or implied warranties, including, without limitation, the implied
       warranties of merchantibility and fitness for a particular purpose.

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

COPYRIGHT AND LICENSE

       This software is copyright (c) 2011 by Jonathan Swartz.

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

perl v5.14.2							    2011-12-16					       CHI::Driver::Memcached(3pm)

MEMCACHED(3)								 1							      MEMCACHED(3)

The Memcached class

INTRODUCTION

	Represents a connection to a set of memcached servers.

CLASS SYNOPSIS

       Memcached

       Memcached

       o public Memcached::__construct ([string  $persistent_id])

       o public bool Memcached::add (string  $key, mixed  $value, [int	$expiration])

       o public bool Memcached::addByKey (string  $server_key, string  $key, mixed  $value, [int  $expiration])

       o public bool Memcached::addServer (string  $host, int  $port, [int  $weight])

       o public bool Memcached::addServers (array  $servers)

       o public bool Memcached::append (string	$key, string  $value)

       o public bool Memcached::appendByKey (string  $server_key, string  $key, string	$value)

       o public bool Memcached::cas (float  $cas_token, string	$key, mixed  $value, [int  $expiration])

       o public bool Memcached::casByKey (float  $cas_token, string  $server_key, string  $key, mixed  $value, [int  $expiration])

       o public int Memcached::decrement (string  $key, [int  $offset = 1], [int  $initial_value], [int  $expiry])

       o public int Memcached::decrementByKey (string  $server_key, string  $key, [int	$offset = 1], [int  $initial_value], [int  $expiry])

       o public bool Memcached::delete (string	$key, [int  $time])

       o public bool Memcached::deleteByKey (string  $server_key, string  $key, [int  $time])

       o public bool Memcached::deleteMulti (array  $keys, [int  $time])

       o public bool Memcached::deleteMultiByKey (string  $server_key, array  $keys, [int  $time])

       o public array Memcached::fetch (void  )

       o public array Memcached::fetchAll (void  )

       o public bool Memcached::flush ([int  $delay])

       o public mixed Memcached::get (string  $key, [callable  $cache_cb], [float  &$cas_token])

       o public array Memcached::getAllKeys (void  )

       o public mixed Memcached::getByKey (string  $server_key, string	$key, [callable  $cache_cb], [float  &$cas_token])

       o public bool Memcached::getDelayed (array  $keys, [bool  $with_cas], [callable	$value_cb])

       o public bool Memcached::getDelayedByKey (string  $server_key, array  $keys, [bool  $with_cas], [callable  $value_cb])

       o public mixed Memcached::getMulti (array  $keys, [array  &$cas_tokens], [int  $flags])

       o public array Memcached::getMultiByKey (string	$server_key, array  $keys, [string  &$cas_tokens], [int  $flags])

       o public mixed Memcached::getOption (int  $option)

       o public int Memcached::getResultCode (void  )

       o public string Memcached::getResultMessage (void  )

       o public array Memcached::getServerByKey (string  $server_key)

       o public array Memcached::getServerList (void  )

       o public array Memcached::getStats (void  )

       o public array Memcached::getVersion (void  )

       o public int Memcached::increment (string  $key, [int  $offset = 1], [int  $initial_value], [int  $expiry])

       o public int Memcached::incrementByKey (string  $server_key, string  $key, [int	$offset = 1], [int  $initial_value], [int  $expiry])

       o public bool Memcached::isPersistent (void  )

       o public bool Memcached::isPristine (void  )

       o public bool Memcached::prepend (string  $key, string  $value)

       o public bool Memcached::prependByKey (string  $server_key, string  $key, string  $value)

       o public bool Memcached::quit (void  )

       o public bool Memcached::replace (string  $key, mixed  $value, [int  $expiration])

       o public bool Memcached::replaceByKey (string  $server_key, string  $key, mixed	$value, [int  $expiration])

       o public bool Memcached::resetServerList (void  )

       o public bool Memcached::set (string  $key, mixed  $value, [int	$expiration])

       o public bool Memcached::setByKey (string  $server_key, string  $key, mixed  $value, [int  $expiration])

       o public bool Memcached::setMulti (array  $items, [int  $expiration])

       o public bool Memcached::setMultiByKey (string  $server_key, array  $items, [int  $expiration])

       o public bool Memcached::setOption (int	$option, mixed	$value)

       o public bool Memcached::setOptions (array  $options)

       o public void Memcached::setSaslAuthData (string  $username, string  $password)

       o public bool Memcached::touch (string  $key, int  $expiration)

       o public bool Memcached::touchByKey (string  $server_key, string  $key, int  $expiration)

PHP Documentation Group 													      MEMCACHED(3)