google/appengine/runtime/Memcached.php

Classes
- \Memcached

Table of Contents

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

\Memcached
jump to top

Package: Default

Constants


       
       
        OPT_PREFIX_KEY
       
       = 1

Constants taken from http://www.php.net/manual/en/memcached.constants.php


       
       
        OPT_COMPRESSION
       
       = 2


       
       
        OPT_DISTRIBUTION
       
       = 4


       
       
        OPT_BUFFER_WRITES
       
       = 5


       
       
        OPT_BINARY_PROTOCOL
       
       = 6


       
       
        OPT_NO_BLOCK
       
       = 7


       
       
        OPT_TCP_NODELAY
       
       = 8


       
       
        OPT_SOCKET_SEND_SIZE
       
       = 9


       
       
        OPT_SOCKET_RECV_SIZE
       
       = 10


       
       
        OPT_CONNECT_TIMEOUT
       
       = 11


       
       
        OPT_RETRY_TIMEOUT
       
       = 12


       
       
        OPT_SEND_TIMEOUT
       
       = 13


       
       
        OPT_RECV_TIMEOUT
       
       = 14


       
       
        OPT_POLL_TIMEOUT
       
       = 15


       
       
        OPT_CACHE_LOOKUPS
       
       = 16


       
       
        OPT_SERVER_FAILURE_LIMIT
       
       = 17


       
       
        OPT_SERIALIZER
       
       = 18


       
       
        HAVE_IGBINARY
       
       = 20


       
       
        SERIALIZER_PHP
       
       = 100


       
       
        SERIALIZER_IGBINARY
       
       = 101


       
       
        SERIALIZER_JSON
       
       = 102


       
       
        HASH_DEFAULT
       
       = 200


       
       
        HASH_FNV1_64
       
       = 203


       
       
        HASH_FNV1A_64
       
       = 204


       
       
        HASH_FNV1_32
       
       = 205


       
       
        HASH_FNV1A_32
       
       = 206


       
       
        HASH_MURMUR
       
       = 208


       
       
        DISTRIBUTION_MODULA
       
       = 300


       
       
        DISTRIBUTION_CONSISTENT
       
       = 301


       
       
        OPT_LIBKETAMA_COMPATIBLE
       
       = 302


       
       
        GET_PRESERVE_ORDER
       
       = 10


       
       
        RES_SUCCESS
       
       = 0


       
       
        RES_FAILURE
       
       = 1


       
       
        RES_HOST_LOOKUP_FAILURE
       
       = 2


       
       
        RES_UNKNOWN_READ_FAILURE
       
       = 7


       
       
        RES_PROTOCOL_ERROR
       
       = 8


       
       
        RES_CLIENT_ERROR
       
       = 9


       
       
        RES_SERVER_ERROR
       
       = 10


       
       
        RES_WRITE_FAILURE
       
       = 5


       
       
        RES_DATA_EXISTS
       
       = 12


       
       
        RES_NOTSTORED
       
       = 14


       
       
        RES_NOTFOUND
       
       = 16


       
       
        RES_PARTIAL_READ
       
       = 18


       
       
        RES_SOME_ERRORS
       
       = 19


       
       
        RES_NO_SERVERS
       
       = 20


       
       
        RES_BUFFERED
       
       = 32


       
       
        RES_TIMEOUT
       
       = 31


       
       
        RES_BAD_KEY_PROVIDED
       
       = 33


       
       
        RES_CONNECTION_SOCKET_CREATE_FAILURE
       
       = 11


       
       
        RES_PAYLOAD_FAILURE
       
       = -1001

Methods


       
       
       
        __construct
       
       
        ( $persistent_id = null)
       
       : void

Parameters

Name	Type	Description
$persistent_id


       
       
       
        add
       
       
        (string $key, mixed $value, int $expiration = 0)
       
       : bool

add is similar to set(), but the operation fails if the key already exists on the server.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	true on success, false on failure.

Details

See: \Memcached::set()


       
       
       
        addByKey
       
       
        (string $server_key, string $key, mixed $value, int $expiration = 0)
       
       : bool

Memcached::addByKey() is functionally equivalent to Memcached::add(), except that the free-form server_key can be used to map the key to a specific server.

This is useful if you need to keep a bunch of related keys on a certain server.

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	true on success, false on failure.

Details

See: \Memcached::add()


       
       
       
        addServer
       
       
        ( $host,  $port,  $weight = 0)
       
       : void

This function is present only for compatibility and does nothing.

Parameters

Name	Type	Description
$host
$port
$weight


       
       
       
        addServers
       
       
        ( $servers)
       
       : void

This function is present only for compatibility and does nothing.

Parameters

Name	Type	Description
$servers


       
       
       
        append
       
       
        (string $key, string $value)
       
       : void

Memcached::append() appends the given value string to the value of an existing item.

The reason that value is forced to be a string is that appending mixed types is not well-defined.

Parameters

Name	Type	Description
$key	string	The key under which to append the value.
$value	string	The value to append

Details

Result: bool Returns true on success or false on failure.


       
       
       
        appendByKey
       
       
        (string $server_key, string $key, string $value)
       
       : void

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to append the value.
$value	string	The value to append

Details

Result: bool Returns true on success or false on failure.
See: \Memcached::append().


       
       
       
        cas
       
       
        (mixed $cas_token, string $key, mixed $value, int $expiration = 0)
       
       : bool

Performs a set and check operation, so that the item will be stored only if no other client has updated it since it was last fetched by this client.

Parameters

Name	Type	Description
$cas_token	mixed	Unique memcached assigned value.
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	True on success, or false on failure.


       
       
       
        casByKey
       
       
        (mixed $cas_token, string $server_key, string $key, mixed $value, int $expiration = 0)
       
       : bool

Parameters

Name	Type	Description
$cas_token	mixed	Unique memcached assigned value.
$server_key	string	Ignored.
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	True on success, or false on failure.

Details

See: \Memcached::cas().


       
       
       
        decrement
       
       
        (string $key, int $offset = 1, int $initial_value = 0, int $expiration = 0)
       
       : bool

Decrements a numeric item's value by $offset.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$offset	int	The amount by which to decrement the item's value.
$initial_value	int	The value to set the item to if it does not currently exist.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	True on success, or false on failure.


       
       
       
        decrementByKey
       
       
        (string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiration = 0)
       
       : bool

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$offset	int	The amount by which to decrement the item's value.
$initial_value	int	The value to set the item to if it does not currently exist.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	True on success, or false on failure.

Details

See: \Memcached::decrement().


       
       
       
        delete
       
       
        (string $key, int $time = 0)
       
       : bool

deletes the $key from the server.

Parameters

Name	Type	Description
$key	string	The key to delete from the server.
$time	int	The time parameter is the amount of time in seconds the client wishes the server to refuse add and replace commands for this key.

Returns

Type	Description
bool	true on success or false on failure.


       
       
       
        deleteByKey
       
       
        (string $server_key, string $key, int $time = 0)
       
       : bool

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key to delete from the server.
$time	int	The time parameter is the amount of time in seconds the client wishes the server to refuse add and replace commands for this key.

Returns

Type	Description
bool	true on success or false on failure.

Details

See: \Memcached::delete().


       
       
       
        deleteMulti
       
       
        (array $keys, int $time = 0)
       
       : bool

deletes an array of $keys from the server.

Parameters

Name	Type	Description
$keys	array	The keys to delete from the server.
$time	int	The time parameter is the amount of time in seconds the client wishes the server to refuse add and replace commands for this key.

Returns

Type	Description
bool	true on success or false on failure.


       
       
       
        deleteMultiByKey
       
       
        (string $server_key, array $keys, int $time = 0)
       
       : bool

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$keys	array	The keys to delete from the server.
$time	int	The time parameter is the amount of time in seconds the client wishes the server to refuse add and replace commands for this key.

Returns

Type	Description
bool	true on success or false on failure.

Details

See: \Memcache::deleteMulti().

fetch retrieves the next result from the last getDelayed() request.

Note that currently getDelayed is a synchronous call.

Returns

Type	Description
\The	next result, or false if there are no more results.

Fetch all of the remaining results from the last getDelayed() request.

Note that currently getDelayed is a synchronous call.

Returns

Type	Description
array	The remaining results, or false if there are no results.


       
       
       
        flush
       
       
        (int $delay = 0)
       
       : bool

Invalidates all existing cache items immediately.

Parameters

Name	Type	Description
$delay	int	This parameter is ignored.

Returns

Type	Description
bool	true on success, or false on failure.


       
       
       
        get
       
       
        (string $key, callable $cache_cb = null, mixed $cas_token = null)
       
       : \the

Returns the item that was previously stored under the $key.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$cache_cb	callable	Read through caching callback.
$cas_token	mixed	The variable to store the CAS token in. This value is opaque to the application.

Returns

Type	Description
\the	value stored in the cache of false if there was a failure.

This function is present only for compatibility and does nothing.


       
       
       
        getByKey
       
       
        (string $server_key, string $key, callable $cache_cb, mixed $cas_token)
       
       : \the

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$cache_cb	callable	Read through caching callback.
$cas_token	mixed	The variable to store the CAS token in. This value is opaque to the application.

Returns

Type	Description
\the	value stored in the cache of false if there was a failure.

Details

See: \Memcache::get().


       
       
       
        getDelayed
       
       
        (array $keys, bool $with_cas = false, callable $value_cb = null)
       
       : bool

Issues a request to memcache for multiple items the keys of which are specified in the keys array.

Currently this method executes synchronously.

Parameters

Name	Type	Description
$keys	array	Array of keys to retrieve.
$with_cas	bool	If true, retrieve the CAS tokens for the keys.
$value_cb	callable	The result callback.

Returns

Type	Description
bool	true on success, or false on failure.


       
       
       
        getDelayedByKey
       
       
        (string $server_key, array $keys, bool $with_cas = false, callable $value_cb = null)
       
       : bool

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$keys	array	Array of keys to retrieve.
$with_cas	bool	If true, retrieve the CAS tokens for the keys.
$value_cb	callable	The result callback.

Returns

Type	Description
bool	true on success, or false on failure.

Details

See: \getDelayedByKey.


       
       
       
        getMulti
       
       
        (array $keys, array $cas_tokens = null, int $flags = 0)
       
       : array

Similar to Memcached::get(), but instead of a single key item, it retrieves multiple items the keys of which are specified in the keys array.

Parameters

Name	Type	Description
$keys	array	Array of keys to retrieve.
$cas_tokens	array	The variable to store the CAS tokens for found items.
$flags	int	The flags for the get operation.

Returns

Type	Description
array	The array of found items for false on failure.

Details

See: \Memcached::get()


       
       
       
        getMultiByKey
       
       
        (string $server_key, array $keys,  $with_cas = false,  $value_cb = null)
       
       : array

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$keys	array	Array of keys to retrieve.
$with_cas
$value_cb

Returns

Type	Description
array	The array of found items for false on failure.

Details

See: \Memcached::getMulti()


       
       
       
        getOption
       
       
        ( $option)
       
       : mixed

Retrieve a Memcached option value.

Parameters

Name	Type	Description
$option

Returns

Type	Description
mixed	the value of the requested option, of false on error.

Details

Params: int $option One of the Memcached::OPT_* constants.


       
       
       
        getResultCode
       
       
        ()
       
       : int

Returns one of the Memcached::RES_* constants that is the result of the last executed Memcached method.

Returns

Type	Description
int	The result code of the last memcached operation.


       
       
       
        getResultMessage
       
       
        ()
       
       : string

Return the message describing the result of the last operation.

Returns

Type	Description
string	Message describing the result of the last operation.


       
       
       
        getServerByKey
       
       
        ( $server_key)
       
       : void

This function is present only for compatibility and does nothing.

Parameters

Name	Type	Description
$server_key


       
       
       
        getServerList
       
       
        ()
       
       : void

This function is present only for compatibility and does nothing.

This function is present only for compatibility and does nothing.

This function is present only for compatibility and does nothing.


       
       
       
        increment
       
       
        (string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0)
       
       : \The

Increments a numeric item's value by the specified offset.

If the item's value is not numeric, and error will result.

Parameters

Name	Type	Description
$key	string	The key of the item to increment
$offset	int	The amount by which to increment the item's value
$initial_value	int	The value to set the item to if it doesn't exist.
$expiry	int	The expiry time to set on the item.

Returns

Type	Description
\The	new item's value on success or false on failure.


       
       
       
        incrementByKey
       
       
        (string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0)
       
       : \The

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key of the item to increment
$offset	int	The amount by which to increment the item's value
$initial_value	int	The value to set the item to if it doesn't exist.
$expiry	int	The expiry time to set on the item.

Returns

Type	Description
\The	new item's value on success or false on failure.

Details

See: \Memcached::increment()


       
       
       
        isPersistent
       
       
        ()
       
       : void

This function is present only for compatibility and does nothing.

This function is present only for compatibility and does nothing.


       
       
       
        prepend
       
       
        (string $key, string $value)
       
       : true

Prepends the given value string to an existing item.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$value	string	The string to prepend.

Returns

Type	Description
true	on success or false on failure.


       
       
       
        prependByKey
       
       
        (string $server_key, string $key, string $value)
       
       : true

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$value	string	The string to prepend.

Returns

Type	Description
true	on success or false on failure.

Details

See: \Memcached::prepend()

This function is present only for compatibility and does nothing.


       
       
       
        replace
       
       
        (string $key, mixed $value, int $expiration = 0)
       
       : true

Replace is similar to Memcache::set(), but the operation will fail if the key is not found on the server.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
true	if the method succeeds, false on failure.


       
       
       
        replaceByKey
       
       
        (string $server_key, string $key, mixed $value, int $expiration = 0)
       
       : true

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
true	if the method succeeds, false on failure.

Details

See: \Memcached::replace()


       
       
       
        resetServerList
       
       
        ()
       
       : void

This function is present only for compatibility and does nothing.


       
       
       
        set
       
       
        (string $key, mixed $value, int $expiration = 0)
       
       : true

Stores the value on a memcache server under the specified key.

The expiration parameters can be used to control when the value is considered expired.

Parameters

Name	Type	Description
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
true	if the method succeeds, false on failure.


       
       
       
        setByKey
       
       
        (string $server_key, string $key, mixed $value, int $expiration = 0)
       
       : true

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to store the value.
$value	mixed	The value to store.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
true	if the method succeeds, false on failure.

Details

See: \Memcached::set()


       
       
       
        setMulti
       
       
        (array $items, int $expiration = 0)
       
       : void

Is similar to Memcached::set(), but instead of a single key/value item, it works on multiple items specified in items.

Parameters

Name	Type	Description
$items	array	An array of key value pairs to set.
$expiration	int	The expiration time to set for the value. returns bool true if the call succeeds, false otherwise.

Details

See: \Memcached::set()


       
       
       
        setMultiByKey
       
       
        (string $server_key, array $items, int $expiration = 0)
       
       : bool

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$items	array	An array of key value pairs to set.
$expiration	int	The expiration time to set for the value.

Returns

Type	Description
bool	true if the call succeeds, false otherwise.

Details

See: \Memcached::setMulti()


       
       
       
        setOption
       
       
        (int $option, mixed $value)
       
       : bool

This method sets the vaue of a memcached option.

Parameters

Name	Type	Description
$option	int	The option to set.
$value	mixed	The value to set the option to.

Returns

Type	Description
bool	true if the call succeeds, false otherwise.


       
       
       
        setOptions
       
       
        (mixed $options)
       
       : bool

This is a varion of Memcached::setOption() that takes an array of options to be set.

Parameters

Name	Type	Description
$options	mixed	An associated array of options.

Returns

Type	Description
bool	true if the call succeeds, false otherwise.


       
       
       
        setSaslAuthData
       
       
        ( $username,  $password)
       
       : void

This function is present only for compatibility and does nothing.

Parameters

Name	Type	Description
$username
$password


       
       
       
        touch
       
       
        (string $key, int $expiration = 0)
       
       : bool

Sets a new expiration time on an item.

Parameters

Name	Type	Description
$key	string	The key under which to append the value.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	true on success or false on failure.


       
       
       
        touchByKey
       
       
        (string $server_key, string $key, int $expiration = 0)
       
       : bool

Functionally equivalent to Memcached::touch().

Parameters

Name	Type	Description
$server_key	string	This parameter is ignored.
$key	string	The key under which to append the value.
$expiration	int	The expiration time, defaults to 0.

Returns

Type	Description
bool	true on success or false on failure.

google/appengine/runtime/Memcached.php

\Memcached jump to top

Constants

Methods

\Memcached
jump to top