org.redisson

Class RedissonBloomFilter<T>

java.lang.Object

org.redisson.RedissonBloomFilter<T>

Type Parameters:

T -

All Implemented Interfaces:

RBloomFilter<T>, RExpirable, RExpirableAsync, RObject, RObjectAsync

public class RedissonBloomFilter<T>
extends Object
implements RBloomFilter<T>

Bloom filter based on 64-bit hash derived from 128-bit hash (xxHash 64-bit + FarmHash 64-bit). Code parts from Guava BloomFilter

Author:

Nikita Koksharov

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonBloomFilter(Codec codec, CommandExecutor commandExecutor, String name)
protected	RedissonBloomFilter(CommandExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T object)
protected boolean	await(io.netty.util.concurrent.Future<?> future, long timeout, TimeUnit timeoutUnit)
boolean	clearExpire() Clear an expire timeout or expire date for object.
io.netty.util.concurrent.Future<Boolean>	clearExpireAsync() Clear an expire timeout or expire date for object in async mode.
boolean	contains(T object)
int	count() Calculates probabilistic number of elements already added to Bloom filter.
boolean	delete() Deletes the object
io.netty.util.concurrent.Future<Boolean>	deleteAsync() Delete object in async mode
protected byte[]	encode(Object value)
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
io.netty.util.concurrent.Future<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
io.netty.util.concurrent.Future<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
io.netty.util.concurrent.Future<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
protected <V> V	get(io.netty.util.concurrent.Future<V> future)
Codec	getCodec() Returns the underlying Codec used by this RObject
long	getExpectedInsertions()
double	getFalseProbability()
int	getHashIterations()
String	getName() Returns name of object
long	getSize()
boolean	isExists() Check object existence
io.netty.util.concurrent.Future<Boolean>	isExistsAsync() Check object existence in async mode.
void	migrate(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance
io.netty.util.concurrent.Future<Void>	migrateAsync(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance in async mode
boolean	move(int database) Move object to another database
io.netty.util.concurrent.Future<Boolean>	moveAsync(int database) Move object to another database in async mode
protected <V> io.netty.util.concurrent.Promise<V>	newPromise()
protected <V> io.netty.util.concurrent.Future<V>	newSucceededFuture(V result)
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
io.netty.util.concurrent.Future<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
void	rename(String newName) Rename current object key to newName
io.netty.util.concurrent.Future<Void>	renameAsync(String newName) Rename current object key to newName in async mode
boolean	renamenx(String newName) Rename current object key to newName only if new key is not exists
io.netty.util.concurrent.Future<Boolean>	renamenxAsync(String newName) Rename current object key to newName in async mode only if new key is not exists
boolean	tryInit(long expectedInsertions, double falseProbability) Initializes Bloom filter params (size and hashIterations) calculated from expectedInsertions and falseProbability Stores config to Redis server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonBloomFilter

protected RedissonBloomFilter(CommandExecutor commandExecutor,
                   String name)

RedissonBloomFilter

protected RedissonBloomFilter(Codec codec,
                   CommandExecutor commandExecutor,
                   String name)

Method Detail

add

public boolean add(T object)

Specified by:

add in interface RBloomFilter<T>

contains

public boolean contains(T object)

Specified by:

contains in interface RBloomFilter<T>

count

public int count()

Description copied from interface: RBloomFilter

Calculates probabilistic number of elements already added to Bloom filter.

Specified by:

count in interface RBloomFilter<T>

Returns:

deleteAsync

public io.netty.util.concurrent.Future<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Returns:

true if object was deleted false if not

tryInit

public boolean tryInit(long expectedInsertions,
              double falseProbability)

Description copied from interface: RBloomFilter

Initializes Bloom filter params (size and hashIterations) calculated from expectedInsertions and falseProbability Stores config to Redis server.

Specified by:

tryInit in interface RBloomFilter<T>

Returns:

true if Bloom filter initialized false if Bloom filter already has been initialized

getExpectedInsertions

public long getExpectedInsertions()

Specified by:

getExpectedInsertions in interface RBloomFilter<T>

getFalseProbability

public double getFalseProbability()

Specified by:

getFalseProbability in interface RBloomFilter<T>

getSize

public long getSize()

Specified by:

getSize in interface RBloomFilter<T>

getHashIterations

public int getHashIterations()

Specified by:

getHashIterations in interface RBloomFilter<T>

expire

public boolean expire(long timeToLive,
             TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public io.netty.util.concurrent.Future<Boolean> expireAsync(long timeToLive,
                                                   TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public io.netty.util.concurrent.Future<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public io.netty.util.concurrent.Future<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Set an expire date for object in async mode. When expire date comes the key will automatically be deleted.

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public io.netty.util.concurrent.Future<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public io.netty.util.concurrent.Future<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds

await

protected boolean await(io.netty.util.concurrent.Future<?> future,
            long timeout,
            TimeUnit timeoutUnit)
                 throws InterruptedException

Throws:

InterruptedException

get

protected <V> V get(io.netty.util.concurrent.Future<V> future)

newPromise

protected <V> io.netty.util.concurrent.Promise<V> newPromise()

newSucceededFuture

protected <V> io.netty.util.concurrent.Future<V> newSucceededFuture(V result)

getName

public String getName()

Description copied from interface: RObject

Returns name of object

Specified by:

getName in interface RObject

Returns:

name

rename

public void rename(String newName)

Description copied from interface: RObject

Rename current object key to newName

Specified by:

rename in interface RObject

renameAsync

public io.netty.util.concurrent.Future<Void> renameAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode

Specified by:

renameAsync in interface RObjectAsync

Returns:

migrate

public void migrate(String host,
           int port,
           int database)

Description copied from interface: RObject

Transfer an object from source Redis instance to destination Redis instance

Specified by:

migrate in interface RObject

Parameters:

host - - destination host

port - - destination port

database - - destination database

migrateAsync

public io.netty.util.concurrent.Future<Void> migrateAsync(String host,
                                                 int port,
                                                 int database)

Description copied from interface: RObjectAsync

Transfer an object from source Redis instance to destination Redis instance in async mode

Specified by:

migrateAsync in interface RObjectAsync

Parameters:

host - - destination host

port - - destination port

database - - destination database

Returns:

move

public boolean move(int database)

Description copied from interface: RObject

Move object to another database

Specified by:

move in interface RObject

Returns:

true if key was moved else false

moveAsync

public io.netty.util.concurrent.Future<Boolean> moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Returns:

true if key was moved false if not

renamenx

public boolean renamenx(String newName)

Description copied from interface: RObject

Rename current object key to newName only if new key is not exists

Specified by:

renamenx in interface RObject

Returns:

renamenxAsync

public io.netty.util.concurrent.Future<Boolean> renamenxAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode only if new key is not exists

Specified by:

renamenxAsync in interface RObjectAsync

Returns:

delete

public boolean delete()

Description copied from interface: RObject

Deletes the object

Specified by:

delete in interface RObject

isExists

public boolean isExists()

Description copied from interface: RObject

Check object existence

Specified by:

isExists in interface RObject

Returns:

true if object exists and false otherwise

isExistsAsync

public io.netty.util.concurrent.Future<Boolean> isExistsAsync()

Description copied from interface: RObjectAsync

Check object existence in async mode.

Specified by:

isExistsAsync in interface RObjectAsync

Returns:

true if object exists and false otherwise

getCodec

public Codec getCodec()

Description copied from interface: RObject

Returns the underlying Codec used by this RObject

Specified by:

getCodec in interface RObject

Returns:

encode

protected byte[] encode(Object value)