org.jredis

Interface JRedisFuture

All Known Implementing Classes:

JRedisAsyncClient, JRedisChunkedPipeline, JRedisFutureSupport, JRedisPipeline

public interface JRedisFuture

The asynchronous interface to Redis.

This is effectively a one to one mapping to Redis commands. Depending on the implementation either the redis response and/or redis write are asynchronous. Regardless, each method returns an extension of Future and the returned results conforms to the contract of that interface (which you should review).

If your request results in a RedisException, the call to Future.get() (of either flavor) will raise a ExecutionException with Throwable.getCause() returning the underlying RedisException.

Similarly, if the request results in either ClientRuntimeException or ProviderException, the Future's ExecutionException will wrap these as the cause.

Beyond that , just be aware that an implementation may throw ClientRuntimeException or an extension to report problems (typically connectivity) or ProviderException (to highlight implementation features/bugs). These are RuntimeException that have been encountered while trying to queue your request.

Note that this interface provides no guarantees whatsoever regarding the execution of your requests beyond the strict ordering of the requests per your invocations. Specifically, in the event of connection issues, this interface's contract does not place any requirements on the implementation beyond to notify the user of such issues either during a call to this interface, or, on the attempt to get the result of a pending response on Future.get(). Refer to the documentation of the implementation of JRedisFuture for the specifics of behavior in context of errors.

Since:

alpha.0

Version:

alpha.0, 04/02/09

Method Summary

Modifier and Type	Method and Description
<K> java.util.concurrent.Future<java.lang.Long>	append(K key, byte[] value)
<K> java.util.concurrent.Future<java.lang.Long>	append(K key, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Long>	append(K key, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	append(K key, T object)
<K> java.util.concurrent.Future<java.lang.String>	bgrewriteaof()
<K> java.util.concurrent.Future<ResponseStatus>	bgsave()
<K> java.util.concurrent.Future<java.lang.Long>	dbsize()
<K> java.util.concurrent.Future<ObjectInfo>	debug(K key)
<K> java.util.concurrent.Future<java.lang.Long>	decr(K key)
<K> java.util.concurrent.Future<java.lang.Long>	decrby(K key, int delta)
<K> java.util.concurrent.Future<java.lang.Long>	del(K... keys)
<K> java.util.concurrent.Future<byte[]>	echo(byte[] msg)
<K> java.util.concurrent.Future<byte[]>	echo(java.lang.Number msg)
<K> java.util.concurrent.Future<byte[]>	echo(java.lang.String msg)
<K,T extends java.io.Serializable> java.util.concurrent.Future<byte[]>	echo(T msg)
<K> java.util.concurrent.Future<java.lang.Boolean>	exists(K key)
<K> java.util.concurrent.Future<java.lang.Boolean>	expire(K key, int ttlseconds)
<K> java.util.concurrent.Future<java.lang.Boolean>	expireat(K key, long epochtimeMillisecs)
java.util.concurrent.Future<ResponseStatus>	flush() Optional connection control command.
<K> java.util.concurrent.Future<ResponseStatus>	flushall() Flushes all dbs in the connect Redis server, regardless of which db was selected on connect time.
<K> java.util.concurrent.Future<ResponseStatus>	flushdb() Flushes the db you selected when connecting to Redis server.
<K> java.util.concurrent.Future<byte[]>	get(K key)
<K> java.util.concurrent.Future<java.lang.Boolean>	getbit(K key, int offset)
<K> java.util.concurrent.Future<byte[]>	getset(K key, byte[] value)
<K> java.util.concurrent.Future<byte[]>	getset(K key, java.lang.Number numberValue)
<K> java.util.concurrent.Future<byte[]>	getset(K key, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<byte[]>	getset(K key, T object)
<K> java.util.concurrent.Future<java.lang.Boolean>	hdel(K key, K entry)
<K> java.util.concurrent.Future<java.lang.Boolean>	hexists(K key, K entry)
<K> java.util.concurrent.Future<byte[]>	hget(K key, K entry)
<K> java.util.concurrent.Future<java.util.Map<byte[],byte[]>>	hgetall(K key)
<K> java.util.concurrent.Future<java.lang.Long>	hincrby(K key, K entry, long increment)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	hkeys(K key)
<K> java.util.concurrent.Future<java.lang.Long>	hlen(K key)
<K> java.util.concurrent.Future<java.lang.Boolean>	hset(K key, K entry, byte[] value)
<K> java.util.concurrent.Future<java.lang.Boolean>	hset(K key, K entry, java.lang.Number number)
<K> java.util.concurrent.Future<java.lang.Boolean>	hset(K key, K entry, java.lang.String string)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	hset(K key, K entry, T object)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	hvals(K key)
<K> java.util.concurrent.Future<java.lang.Long>	incr(K key)
<K> java.util.concurrent.Future<java.lang.Long>	incrby(K key, int delta)
<K> java.util.concurrent.Future<java.util.Map<java.lang.String,java.lang.String>>	info()
<K> java.util.concurrent.Future<java.util.List<byte[]>>	keys() Convenience method.
<K> java.util.concurrent.Future<java.util.List<byte[]>>	keys(K pattern)
<K> java.util.concurrent.Future<java.lang.Long>	lastsave()
<K> java.util.concurrent.Future<byte[]>	lindex(K listkey, long index)
<K> java.util.concurrent.Future<java.lang.Long>	llen(K listkey) Given a 'list' key, returns the number of items in the list.
<K> java.util.concurrent.Future<byte[]>	lpop(K listkey)
<K> java.util.concurrent.Future<java.lang.Long>	lpush(K listkey, byte[] value)
<K> java.util.concurrent.Future<java.lang.Long>	lpush(K listkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Long>	lpush(K listkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	lpush(K listkey, T object)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	lrange(K listkey, long from, long to)
<K> java.util.concurrent.Future<java.lang.Long>	lrem(K listkey, byte[] value, int count)
<K> java.util.concurrent.Future<java.lang.Long>	lrem(K listkey, java.lang.Number numberValue, int count)
<K> java.util.concurrent.Future<java.lang.Long>	lrem(K listkey, java.lang.String stringValue, int count)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	lrem(K listkey, T object, int count)
<K> java.util.concurrent.Future<ResponseStatus>	lset(K key, long index, byte[] value)
<K> java.util.concurrent.Future<ResponseStatus>	lset(K key, long index, java.lang.Number numberValue)
<K> java.util.concurrent.Future<ResponseStatus>	lset(K key, long index, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus>	lset(K key, long index, T object)
<K> java.util.concurrent.Future<ResponseStatus>	ltrim(K listkey, long keepFrom, long keepTo)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	mget(java.lang.String... keys)
<K> java.util.concurrent.Future<java.lang.Boolean>	move(K key, int dbIndex) Moves the given key from the currently selected db to the one indicated by dbIndex.
<K> java.util.concurrent.Future<ResponseStatus>	mset(KeyValueSet.ByteArrays<K> mappings)
<K> java.util.concurrent.Future<ResponseStatus>	mset(KeyValueSet.Numbers<K> mappings)
<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus>	mset(KeyValueSet.Objects<K,T> mappings)
<K> java.util.concurrent.Future<ResponseStatus>	mset(KeyValueSet.Strings<K> mappings)
<K> java.util.concurrent.Future<ResponseStatus>	mset(java.util.Map<K,byte[]> keyValueMap)
<K> java.util.concurrent.Future<java.lang.Boolean>	msetnx(KeyValueSet.ByteArrays<K> mappings)
<K> java.util.concurrent.Future<java.lang.Boolean>	msetnx(KeyValueSet.Numbers<K> mappings)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	msetnx(KeyValueSet.Objects<K,T> mappings)
<K> java.util.concurrent.Future<java.lang.Boolean>	msetnx(KeyValueSet.Strings<K> mappings)
<K> java.util.concurrent.Future<java.lang.Boolean>	msetnx(java.util.Map<K,byte[]> keyValueMap)
<K> java.util.concurrent.Future<ResponseStatus>	ping() Ping redis
<K> java.util.concurrent.Future<ResponseStatus>	quit() Disconnects the client.
<K> java.util.concurrent.Future<byte[]>	randomkey()
<K> java.util.concurrent.Future<ResponseStatus>	rename(K oldkey, K newkey)
<K> java.util.concurrent.Future<java.lang.Boolean>	renamenx(K oldkey, K brandnewkey)
<K> java.util.concurrent.Future<byte[]>	rpop(K listkey)
<K> java.util.concurrent.Future<byte[]>	rpoplpush(java.lang.String srcList, java.lang.String destList)
<K> java.util.concurrent.Future<java.lang.Long>	rpush(K listkey, byte[] value)
<K> java.util.concurrent.Future<java.lang.Long>	rpush(K listkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Long>	rpush(K listkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	rpush(K listkey, T object)
<K> java.util.concurrent.Future<java.lang.Boolean>	sadd(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	sadd(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	sadd(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	sadd(K setkey, T object)
<K> java.util.concurrent.Future<ResponseStatus>	save()
<K> java.util.concurrent.Future<java.lang.Long>	scard(K setKey)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	sdiff(K set1, K... sets)
<K> java.util.concurrent.Future<ResponseStatus>	sdiffstore(K destSetKey, K... sets)
<K> java.util.concurrent.Future<ResponseStatus>	set(K key, byte[] value) Bind the value to key.
<K> java.util.concurrent.Future<ResponseStatus>	set(K key, java.lang.Number numberValue) Convenient method for String numeric values binding
<K> java.util.concurrent.Future<ResponseStatus>	set(K key, java.lang.String stringValue) Convenient method for String data binding
<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus>	set(K key, T object) Binds the given java Object to the key.
<K> java.util.concurrent.Future<java.lang.Boolean>	setbit(K key, int offset, boolean value)
<K> java.util.concurrent.Future<java.lang.Boolean>	setnx(K key, byte[] value)
<K> java.util.concurrent.Future<java.lang.Boolean>	setnx(K key, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	setnx(K key, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	setnx(K key, T object)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	sinter(K set1, K... sets)
<K> java.util.concurrent.Future<ResponseStatus>	sinterstore(K destSetKey, K... sets)
<K> java.util.concurrent.Future<java.lang.Boolean>	sismember(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	sismember(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	sismember(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	sismember(K setkey, T object)
<K> java.util.concurrent.Future<ResponseStatus>	slaveof(java.lang.String host, int port)
<K> java.util.concurrent.Future<ResponseStatus>	slaveofnone() Convenience method.
<K> java.util.concurrent.Future<java.util.List<byte[]>>	smembers(K setkey)
<K> java.util.concurrent.Future<java.lang.Boolean>	smove(K srcKey, K destKey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	smove(K srcKey, K destKey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	smove(K srcKey, K destKey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	smove(K srcKey, K destKey, T object)
<K> Sort	sort(K key) For Usage details regarding sort semantics, see JRedis.sort(K).
<K> java.util.concurrent.Future<byte[]>	spop(K setkey)
<K> java.util.concurrent.Future<byte[]>	srandmember(K setkey)
<K> java.util.concurrent.Future<java.lang.Boolean>	srem(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	srem(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	srem(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	srem(K setkey, T object)
<K> java.util.concurrent.Future<byte[]>	substr(K listkey, long from, long to)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	sunion(K set1, K... sets)
<K> java.util.concurrent.Future<ResponseStatus>	sunionstore(K destSetKey, K... sets)
<K> java.util.concurrent.Future<java.lang.Long>	ttl(K key)
<K> java.util.concurrent.Future<RedisType>	type(K key)
<K> java.util.concurrent.Future<java.lang.Boolean>	zadd(K setkey, double score, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	zadd(K setkey, double score, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	zadd(K setkey, double score, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	zadd(K setkey, double score, T object)
<K> java.util.concurrent.Future<java.lang.Long>	zcard(K setKey)
<K> java.util.concurrent.Future<java.lang.Long>	zcount(K setkey, double minScore, double maxScore)
<K> java.util.concurrent.Future<java.lang.Double>	zincrby(K setkey, double score, byte[] member)
<K> java.util.concurrent.Future<java.lang.Double>	zincrby(K setkey, double score, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Double>	zincrby(K setkey, double score, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Double>	zincrby(K setkey, double score, T object)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	zrange(K setkey, long from, long to)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	zrangebyscore(K setkey, double minScore, double maxScore)
<K> java.util.concurrent.Future<java.util.List<ZSetEntry>>	zrangebyscoreSubset(K setkey, double minScore, double maxScore)
<K> java.util.concurrent.Future<java.util.List<ZSetEntry>>	zrangeSubset(K setkey, long from, long to) Equivalent to JRedis#zrange(String, long, long) with the Command.Option#WITHSCORES.
<K> java.util.concurrent.Future<java.lang.Long>	zrank(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Long>	zrank(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Long>	zrank(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	zrank(K setkey, T object)
<K> java.util.concurrent.Future<java.lang.Boolean>	zrem(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Boolean>	zrem(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Boolean>	zrem(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean>	zrem(K setkey, T object)
<K> java.util.concurrent.Future<java.lang.Long>	zremrangebyrank(K setkey, long minRank, long maxRank)
<K> java.util.concurrent.Future<java.lang.Long>	zremrangebyscore(K setkey, double minScore, double maxScore)
<K> java.util.concurrent.Future<java.util.List<byte[]>>	zrevrange(K setkey, long from, long to)
<K> java.util.concurrent.Future<java.util.List<ZSetEntry>>	zrevrangeSubset(K setkey, long from, long to) Equivalent to JRedis#zrange(String, long, long) with the Command.Option#WITHSCORES.
<K> java.util.concurrent.Future<java.lang.Long>	zrevrank(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Long>	zrevrank(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Long>	zrevrank(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long>	zrevrank(K setkey, T object)
<K> java.util.concurrent.Future<java.lang.Double>	zscore(K setkey, byte[] member)
<K> java.util.concurrent.Future<java.lang.Double>	zscore(K setkey, java.lang.Number numberValue)
<K> java.util.concurrent.Future<java.lang.Double>	zscore(K setkey, java.lang.String stringValue)
<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Double>	zscore(K setkey, T object)

Method Detail

ping

<K> java.util.concurrent.Future<ResponseStatus> ping()

Ping redis

quit

<K> java.util.concurrent.Future<ResponseStatus> quit()

Disconnects the client.

flush

java.util.concurrent.Future<ResponseStatus> flush()

Optional connection control command.

Type Parameters:

K -

Returns:

set

<K> java.util.concurrent.Future<ResponseStatus> set(K key,
                                                    byte[] value)

Bind the value to key.

Parameters:

key - any UTF-8 String

value - any bytes. For current data size limitations, refer to Redis documentation.

Throws:

ProviderException - on un-documented features/bug

ClientRuntimeException - on errors due to operating environment (Redis or network)

set

<K> java.util.concurrent.Future<ResponseStatus> set(K key,
                                                    java.lang.String stringValue)

Convenient method for String data binding

Parameters:

key -

stringValue -

See Also:

JRedis#set(String, byte[])}

set

<K> java.util.concurrent.Future<ResponseStatus> set(K key,
                                                    java.lang.Number numberValue)

Convenient method for String numeric values binding

Parameters:

key -

numberValue -

See Also:

JRedis#set(String, byte[])}

set

<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus> set(K key,
                                                                                   T object)

Binds the given java Object to the key. Serialization format is implementation specific. Simple implementations may apply the basic Serializable protocol.

Type Parameters:

T -

Parameters:

key -

object -

See Also:

JRedis#set(String, byte[])}

setnx

<K> java.util.concurrent.Future<java.lang.Boolean> setnx(K key,
                                                         byte[] value)

Parameters:

key -

value -

Returns:

setnx

<K> java.util.concurrent.Future<java.lang.Boolean> setnx(K key,
                                                         java.lang.String stringValue)

setnx

<K> java.util.concurrent.Future<java.lang.Boolean> setnx(K key,
                                                         java.lang.Number numberValue)

setnx

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> setnx(K key,
                                                                                        T object)

setbit

<K> java.util.concurrent.Future<java.lang.Boolean> setbit(K key,
                                                          int offset,
                                                          boolean value)

get

<K> java.util.concurrent.Future<byte[]> get(K key)

Parameters:

key -

Returns:

getset

<K> java.util.concurrent.Future<byte[]> getset(K key,
                                               byte[] value)

getset

<K> java.util.concurrent.Future<byte[]> getset(K key,
                                               java.lang.String stringValue)

getset

<K> java.util.concurrent.Future<byte[]> getset(K key,
                                               java.lang.Number numberValue)

getset

<K,T extends java.io.Serializable> java.util.concurrent.Future<byte[]> getset(K key,
                                                                              T object)

getbit

<K> java.util.concurrent.Future<java.lang.Boolean> getbit(K key,
                                                          int offset)

mget

<K> java.util.concurrent.Future<java.util.List<byte[]>> mget(java.lang.String... keys)

Parameters:

key -

moreKeys -

Returns:

mset

<K> java.util.concurrent.Future<ResponseStatus> mset(java.util.Map<K,byte[]> keyValueMap)

Parameters:

keyValueMap - a Mapping of String key names to byte[] values.

Returns:

Future indicating if all of sets were OK or not

Throws:

RedisException

mset

<K> java.util.concurrent.Future<ResponseStatus> mset(KeyValueSet.ByteArrays<K> mappings)

mset

<K> java.util.concurrent.Future<ResponseStatus> mset(KeyValueSet.Strings<K> mappings)

mset

<K> java.util.concurrent.Future<ResponseStatus> mset(KeyValueSet.Numbers<K> mappings)

mset

<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus> mset(KeyValueSet.Objects<K,T> mappings)

msetnx

<K> java.util.concurrent.Future<java.lang.Boolean> msetnx(java.util.Map<K,byte[]> keyValueMap)

Parameters:

keyValueMap - a Mapping of String key names to byte[] values.

Returns:

Future indicating if all of sets were OK or not

Throws:

RedisException

msetnx

<K> java.util.concurrent.Future<java.lang.Boolean> msetnx(KeyValueSet.ByteArrays<K> mappings)

msetnx

<K> java.util.concurrent.Future<java.lang.Boolean> msetnx(KeyValueSet.Strings<K> mappings)

msetnx

<K> java.util.concurrent.Future<java.lang.Boolean> msetnx(KeyValueSet.Numbers<K> mappings)

msetnx

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> msetnx(KeyValueSet.Objects<K,T> mappings)

incr

<K> java.util.concurrent.Future<java.lang.Long> incr(K key)

Parameters:

key -

Returns:

incrby

<K> java.util.concurrent.Future<java.lang.Long> incrby(K key,
                                                       int delta)

Parameters:

key -

delta -

Returns:

decr

<K> java.util.concurrent.Future<java.lang.Long> decr(K key)

Parameters:

key -

Returns:

decrby

<K> java.util.concurrent.Future<java.lang.Long> decrby(K key,
                                                       int delta)

Parameters:

key -

delta -

Returns:

substr

<K> java.util.concurrent.Future<byte[]> substr(K listkey,
                                               long from,
                                               long to)

Parameters:

listkey -

from -

to -

Returns:

append

<K> java.util.concurrent.Future<java.lang.Long> append(K key,
                                                       byte[] value)

Parameters:

key -

value -

Returns:

the length (byte count) of appended key.

append

<K> java.util.concurrent.Future<java.lang.Long> append(K key,
                                                       java.lang.String stringValue)

append

<K> java.util.concurrent.Future<java.lang.Long> append(K key,
                                                       java.lang.Number numberValue)

append

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> append(K key,
                                                                                      T object)

exists

<K> java.util.concurrent.Future<java.lang.Boolean> exists(K key)

Parameters:

key -

Returns:

del

<K> java.util.concurrent.Future<java.lang.Long> del(K... keys)

Parameters:

keys - one or more, non-null, non-zero-length, keys to be deleted

Returns:

Future of number keys actually deleted.

type

<K> java.util.concurrent.Future<RedisType> type(K key)

Parameters:

key -

Returns:

keys

<K> java.util.concurrent.Future<java.util.List<byte[]>> keys(K pattern)

Parameters:

pattern -

Returns:

keys

<K> java.util.concurrent.Future<java.util.List<byte[]>> keys()

Convenience method. Equivalent to calling jredis.keys("*");

Returns:

See Also:

JRedis#keys(String)}

randomkey

<K> java.util.concurrent.Future<byte[]> randomkey()

Returns:

rename

<K> java.util.concurrent.Future<ResponseStatus> rename(K oldkey,
                                                       K newkey)

Parameters:

oldkey -

newkey -

renamenx

<K> java.util.concurrent.Future<java.lang.Boolean> renamenx(K oldkey,
                                                            K brandnewkey)

Parameters:

oldkey -

brandnewkey -

Returns:

dbsize

<K> java.util.concurrent.Future<java.lang.Long> dbsize()

Returns:

expire

<K> java.util.concurrent.Future<java.lang.Boolean> expire(K key,
                                                          int ttlseconds)

Parameters:

key -

ttlseconds -

Returns:

expireat

<K> java.util.concurrent.Future<java.lang.Boolean> expireat(K key,
                                                            long epochtimeMillisecs)

Parameters:

key -

UNIX - epoch-time in milliseconds. Note that Redis expects epochtime in seconds. Implementations are responsible for converting to seconds. method

Returns:

See Also:

System#currentTimeMillis()}

ttl

<K> java.util.concurrent.Future<java.lang.Long> ttl(K key)

Parameters:

key -

Returns:

rpush

<K> java.util.concurrent.Future<java.lang.Long> rpush(K listkey,
                                                      byte[] value)

Parameters:

listkey -

value -

rpush

<K> java.util.concurrent.Future<java.lang.Long> rpush(K listkey,
                                                      java.lang.String stringValue)

rpush

<K> java.util.concurrent.Future<java.lang.Long> rpush(K listkey,
                                                      java.lang.Number numberValue)

rpush

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> rpush(K listkey,
                                                                                     T object)

lpush

<K> java.util.concurrent.Future<java.lang.Long> lpush(K listkey,
                                                      byte[] value)

Parameters:

listkey -

value -

lpush

<K> java.util.concurrent.Future<java.lang.Long> lpush(K listkey,
                                                      java.lang.String stringValue)

lpush

<K> java.util.concurrent.Future<java.lang.Long> lpush(K listkey,
                                                      java.lang.Number numberValue)

lpush

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> lpush(K listkey,
                                                                                     T object)

lset

<K> java.util.concurrent.Future<ResponseStatus> lset(K key,
                                                     long index,
                                                     byte[] value)

Parameters:

key -

index -

value -

lset

<K> java.util.concurrent.Future<ResponseStatus> lset(K key,
                                                     long index,
                                                     java.lang.String stringValue)

lset

<K> java.util.concurrent.Future<ResponseStatus> lset(K key,
                                                     long index,
                                                     java.lang.Number numberValue)

lset

<K,T extends java.io.Serializable> java.util.concurrent.Future<ResponseStatus> lset(K key,
                                                                                    long index,
                                                                                    T object)

lrem

<K> java.util.concurrent.Future<java.lang.Long> lrem(K listkey,
                                                     byte[] value,
                                                     int count)

Parameters:

listKey -

value -

count -

Returns:

lrem

<K> java.util.concurrent.Future<java.lang.Long> lrem(K listkey,
                                                     java.lang.String stringValue,
                                                     int count)

lrem

<K> java.util.concurrent.Future<java.lang.Long> lrem(K listkey,
                                                     java.lang.Number numberValue,
                                                     int count)

lrem

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> lrem(K listkey,
                                                                                    T object,
                                                                                    int count)

llen

<K> java.util.concurrent.Future<java.lang.Long> llen(K listkey)

Given a 'list' key, returns the number of items in the list.

Parameters:

listkey -

Returns:

lrange

<K> java.util.concurrent.Future<java.util.List<byte[]>> lrange(K listkey,
                                                               long from,
                                                               long to)

Parameters:

listkey -

from -

to -

Returns:

ltrim

<K> java.util.concurrent.Future<ResponseStatus> ltrim(K listkey,
                                                      long keepFrom,
                                                      long keepTo)

Parameters:

listkey -

keepFrom -

keepTo -

lindex

<K> java.util.concurrent.Future<byte[]> lindex(K listkey,
                                               long index)

Parameters:

listkey -

index -

Returns:

lpop

<K> java.util.concurrent.Future<byte[]> lpop(K listkey)

Parameters:

listKey -

Returns:

rpop

<K> java.util.concurrent.Future<byte[]> rpop(K listkey)

Parameters:

listKey -

Returns:

rpoplpush

<K> java.util.concurrent.Future<byte[]> rpoplpush(java.lang.String srcList,
                                                  java.lang.String destList)

Parameters:

srcList -

destList -

Returns:

sadd

<K> java.util.concurrent.Future<java.lang.Boolean> sadd(K setkey,
                                                        byte[] member)

Parameters:

setkey -

member -

Returns:

sadd

<K> java.util.concurrent.Future<java.lang.Boolean> sadd(K setkey,
                                                        java.lang.String stringValue)

sadd

<K> java.util.concurrent.Future<java.lang.Boolean> sadd(K setkey,
                                                        java.lang.Number numberValue)

sadd

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> sadd(K setkey,
                                                                                       T object)

srem

<K> java.util.concurrent.Future<java.lang.Boolean> srem(K setkey,
                                                        byte[] member)

Parameters:

setKey -

member -

Returns:

srem

<K> java.util.concurrent.Future<java.lang.Boolean> srem(K setkey,
                                                        java.lang.String stringValue)

srem

<K> java.util.concurrent.Future<java.lang.Boolean> srem(K setkey,
                                                        java.lang.Number numberValue)

srem

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> srem(K setkey,
                                                                                       T object)

sismember

<K> java.util.concurrent.Future<java.lang.Boolean> sismember(K setkey,
                                                             byte[] member)

Parameters:

setKey -

member -

Returns:

sismember

<K> java.util.concurrent.Future<java.lang.Boolean> sismember(K setkey,
                                                             java.lang.String stringValue)

sismember

<K> java.util.concurrent.Future<java.lang.Boolean> sismember(K setkey,
                                                             java.lang.Number numberValue)

sismember

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> sismember(K setkey,
                                                                                            T object)

smove

<K> java.util.concurrent.Future<java.lang.Boolean> smove(K srcKey,
                                                         K destKey,
                                                         byte[] member)

Parameters:

srcKey -

destKey -

member -

Returns:

smove

<K> java.util.concurrent.Future<java.lang.Boolean> smove(K srcKey,
                                                         K destKey,
                                                         java.lang.String stringValue)

smove

<K> java.util.concurrent.Future<java.lang.Boolean> smove(K srcKey,
                                                         K destKey,
                                                         java.lang.Number numberValue)

smove

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> smove(K srcKey,
                                                                                        K destKey,
                                                                                        T object)

scard

<K> java.util.concurrent.Future<java.lang.Long> scard(K setKey)

Parameters:

setKey -

Returns:

sinter

<K> java.util.concurrent.Future<java.util.List<byte[]>> sinter(K set1,
                                                               K... sets)

Parameters:

set1 -

sets -

Returns:

sinterstore

<K> java.util.concurrent.Future<ResponseStatus> sinterstore(K destSetKey,
                                                            K... sets)

Parameters:

destSetKey -

sets -

sunion

<K> java.util.concurrent.Future<java.util.List<byte[]>> sunion(K set1,
                                                               K... sets)

Parameters:

set1 -

sets -

Returns:

sunionstore

<K> java.util.concurrent.Future<ResponseStatus> sunionstore(K destSetKey,
                                                            K... sets)

Parameters:

destSetKey -

sets -

sdiff

<K> java.util.concurrent.Future<java.util.List<byte[]>> sdiff(K set1,
                                                              K... sets)

Parameters:

set1 -

sets -

Returns:

sdiffstore

<K> java.util.concurrent.Future<ResponseStatus> sdiffstore(K destSetKey,
                                                           K... sets)

Parameters:

destSetKey -

sets -

smembers

<K> java.util.concurrent.Future<java.util.List<byte[]>> smembers(K setkey)

Parameters:

setkey -

Returns:

srandmember

<K> java.util.concurrent.Future<byte[]> srandmember(K setkey)

Parameters:

setkey -

Returns:

spop

<K> java.util.concurrent.Future<byte[]> spop(K setkey)

Parameters:

setkey -

Returns:

zadd

<K> java.util.concurrent.Future<java.lang.Boolean> zadd(K setkey,
                                                        double score,
                                                        byte[] member)

Parameters:

setkey -

score -

member -

Returns:

zadd

<K> java.util.concurrent.Future<java.lang.Boolean> zadd(K setkey,
                                                        double score,
                                                        java.lang.String stringValue)

zadd

<K> java.util.concurrent.Future<java.lang.Boolean> zadd(K setkey,
                                                        double score,
                                                        java.lang.Number numberValue)

zadd

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> zadd(K setkey,
                                                                                       double score,
                                                                                       T object)

zrem

<K> java.util.concurrent.Future<java.lang.Boolean> zrem(K setkey,
                                                        byte[] member)

Parameters:

setKey -

member -

Returns:

zrem

<K> java.util.concurrent.Future<java.lang.Boolean> zrem(K setkey,
                                                        java.lang.String stringValue)

zrem

<K> java.util.concurrent.Future<java.lang.Boolean> zrem(K setkey,
                                                        java.lang.Number numberValue)

zrem

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> zrem(K setkey,
                                                                                       T object)

zcard

<K> java.util.concurrent.Future<java.lang.Long> zcard(K setKey)

Parameters:

setKey -

Returns:

zscore

<K> java.util.concurrent.Future<java.lang.Double> zscore(K setkey,
                                                         byte[] member)

Parameters:

setkey -

member -

Returns:

zscore

<K> java.util.concurrent.Future<java.lang.Double> zscore(K setkey,
                                                         java.lang.String stringValue)

zscore

<K> java.util.concurrent.Future<java.lang.Double> zscore(K setkey,
                                                         java.lang.Number numberValue)

zscore

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Double> zscore(K setkey,
                                                                                        T object)

zrank

<K> java.util.concurrent.Future<java.lang.Long> zrank(K setkey,
                                                      byte[] member)

Parameters:

setkey -

member -

Returns:

zrank

<K> java.util.concurrent.Future<java.lang.Long> zrank(K setkey,
                                                      java.lang.String stringValue)

zrank

<K> java.util.concurrent.Future<java.lang.Long> zrank(K setkey,
                                                      java.lang.Number numberValue)

zrank

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> zrank(K setkey,
                                                                                     T object)

zrevrank

<K> java.util.concurrent.Future<java.lang.Long> zrevrank(K setkey,
                                                         byte[] member)

Parameters:

setkey -

member -

Returns:

zrevrank

<K> java.util.concurrent.Future<java.lang.Long> zrevrank(K setkey,
                                                         java.lang.String stringValue)

zrevrank

<K> java.util.concurrent.Future<java.lang.Long> zrevrank(K setkey,
                                                         java.lang.Number numberValue)

zrevrank

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Long> zrevrank(K setkey,
                                                                                        T object)

zrange

<K> java.util.concurrent.Future<java.util.List<byte[]>> zrange(K setkey,
                                                               long from,
                                                               long to)

Parameters:

setkey -

from -

to -

Returns:

zrevrange

<K> java.util.concurrent.Future<java.util.List<byte[]>> zrevrange(K setkey,
                                                                  long from,
                                                                  long to)

Parameters:

setkey -

from -

to -

Returns:

zrangeSubset

<K> java.util.concurrent.Future<java.util.List<ZSetEntry>> zrangeSubset(K setkey,
                                                                        long from,
                                                                        long to)

Equivalent to JRedis#zrange(String, long, long) with the Command.Option#WITHSCORES. Unlike the general ZRANGE command that only returns the values, this method returns both values and associated scores for the specified range.

Parameters:

setkey -

from -

to -

Returns:

See Also:

JRedis#zrange(String, long, long), ZSetEntry

zrevrangeSubset

<K> java.util.concurrent.Future<java.util.List<ZSetEntry>> zrevrangeSubset(K setkey,
                                                                           long from,
                                                                           long to)

Equivalent to JRedis#zrange(String, long, long) with the Command.Option#WITHSCORES. Unlike the general ZRANGE command that only returns the values, this method returns both values and associated scores for the specified range.

Parameters:

setkey -

from -

to -

Returns:

See Also:

JRedis#zrevrange(String, long, long), ZSetEntry

zincrby

<K> java.util.concurrent.Future<java.lang.Double> zincrby(K setkey,
                                                          double score,
                                                          byte[] member)

Parameters:

setkey -

score -

member -

Returns:

zincrby

<K> java.util.concurrent.Future<java.lang.Double> zincrby(K setkey,
                                                          double score,
                                                          java.lang.String stringValue)

zincrby

<K> java.util.concurrent.Future<java.lang.Double> zincrby(K setkey,
                                                          double score,
                                                          java.lang.Number numberValue)

zincrby

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Double> zincrby(K setkey,
                                                                                         double score,
                                                                                         T object)

zrangebyscore

<K> java.util.concurrent.Future<java.util.List<byte[]>> zrangebyscore(K setkey,
                                                                      double minScore,
                                                                      double maxScore)

Parameters:

setkey -

from -

to -

Returns:

zrangebyscoreSubset

<K> java.util.concurrent.Future<java.util.List<ZSetEntry>> zrangebyscoreSubset(K setkey,
                                                                               double minScore,
                                                                               double maxScore)

Parameters:

setkey -

minScore -

maxScore -

Returns:

zremrangebyscore

<K> java.util.concurrent.Future<java.lang.Long> zremrangebyscore(K setkey,
                                                                 double minScore,
                                                                 double maxScore)

Parameters:

setkey -

from -

to -

Returns:

number of removed elements

zcount

<K> java.util.concurrent.Future<java.lang.Long> zcount(K setkey,
                                                       double minScore,
                                                       double maxScore)

Parameters:

setkey -

minScore -

maxScore -

Returns:

number of removed elements

zremrangebyrank

<K> java.util.concurrent.Future<java.lang.Long> zremrangebyrank(K setkey,
                                                                long minRank,
                                                                long maxRank)

Parameters:

setkey -

from -

to -

Returns:

number of removed elements

hset

<K> java.util.concurrent.Future<java.lang.Boolean> hset(K key,
                                                        K entry,
                                                        byte[] value)

Parameters:

key -

field -

value -

Returns:

hset

<K> java.util.concurrent.Future<java.lang.Boolean> hset(K key,
                                                        K entry,
                                                        java.lang.String string)

Parameters:

key -

field -

string -

Returns:

hset

<K> java.util.concurrent.Future<java.lang.Boolean> hset(K key,
                                                        K entry,
                                                        java.lang.Number number)

Parameters:

key -

field -

number -

Returns:

hset

<K,T extends java.io.Serializable> java.util.concurrent.Future<java.lang.Boolean> hset(K key,
                                                                                       K entry,
                                                                                       T object)

Type Parameters:

T -

Parameters:

key -

field -

object -

Returns:

hget

<K> java.util.concurrent.Future<byte[]> hget(K key,
                                             K entry)

Parameters:

key -

field -

Returns:

hincrby

<K> java.util.concurrent.Future<java.lang.Long> hincrby(K key,
                                                        K entry,
                                                        long increment)

Parameters:

key -

entry -

increment -

Returns:

hexists

<K> java.util.concurrent.Future<java.lang.Boolean> hexists(K key,
                                                           K entry)

Parameters:

key -

field -

Returns:

true if the spec'd field exists for the spec'd (hash type) key

hdel

<K> java.util.concurrent.Future<java.lang.Boolean> hdel(K key,
                                                        K entry)

Parameters:

key -

field -

Returns:

true if the spec'd field exists for the spec'd (hash type) key

hlen

<K> java.util.concurrent.Future<java.lang.Long> hlen(K key)

Parameters:

key -

field -

Returns:

# of fields/entries for the given hash type key

hkeys

<K> java.util.concurrent.Future<java.util.List<byte[]>> hkeys(K key)

Parameters:

key -

Returns:

list of keys in the given hashtable.

Throws:

RedisException

hvals

<K> java.util.concurrent.Future<java.util.List<byte[]>> hvals(K key)

Parameters:

key -

Returns:

list of values in the given hashtable.

Throws:

RedisException

hgetall

<K> java.util.concurrent.Future<java.util.Map<byte[],byte[]>> hgetall(K key)

Parameters:

key -

Returns:

the given hash as a Map

Throws:

RedisException

flushdb

<K> java.util.concurrent.Future<ResponseStatus> flushdb()

Flushes the db you selected when connecting to Redis server. Typically, implementations will select db 0 on connecting if non was specified. Remember that there is no roll-back.

Returns:

flushall

<K> java.util.concurrent.Future<ResponseStatus> flushall()

Flushes all dbs in the connect Redis server, regardless of which db was selected on connect time. Remember that there is no rollback.

Returns:

move

<K> java.util.concurrent.Future<java.lang.Boolean> move(K key,
                                                        int dbIndex)

Moves the given key from the currently selected db to the one indicated by dbIndex.

Parameters:

key -

dbIndex -

Returns:

sort

<K> Sort sort(K key)

For Usage details regarding sort semantics, see JRedis.sort(K). The only difference in usage is that you must use the Query.execAsync() method which returns a Future instances.

Usage:

 Future>  futureResults = redis.sort("my-list-or-set-key").BY("weight*").LIMIT(1, 11).GET("object*").DESC().ALPHA().execAsync();
 List results = futureResult.get();  // wait for the asynchronous response to be processed
 for(byte[] item : results) {
     // do something with item ..
  }
 

See Also:

Redis, Future

save

<K> java.util.concurrent.Future<ResponseStatus> save()

bgsave

<K> java.util.concurrent.Future<ResponseStatus> bgsave()

bgrewriteaof

<K> java.util.concurrent.Future<java.lang.String> bgrewriteaof()

Returns:

ack message.

lastsave

<K> java.util.concurrent.Future<java.lang.Long> lastsave()

Returns:

info

<K> java.util.concurrent.Future<java.util.Map<java.lang.String,java.lang.String>> info()

Returns:

slaveof

<K> java.util.concurrent.Future<ResponseStatus> slaveof(java.lang.String host,
                                                        int port)

Parameters:

host - ip address

port -

slaveofnone

<K> java.util.concurrent.Future<ResponseStatus> slaveofnone()

Convenience method. Turns off replication.

echo

<K> java.util.concurrent.Future<byte[]> echo(byte[] msg)

Parameters:

msg -

Returns:

echo

<K> java.util.concurrent.Future<byte[]> echo(java.lang.String msg)

echo

<K> java.util.concurrent.Future<byte[]> echo(java.lang.Number msg)

echo

<K,T extends java.io.Serializable> java.util.concurrent.Future<byte[]> echo(T msg)

debug

<K> java.util.concurrent.Future<ObjectInfo> debug(K key)

Parameters:

key -

Returns: