Overview (lettuce 4.1.2.Final API)

Packages
Package	Description
com.lambdaworks.codec	Base16 and CRC16 codecs.
com.lambdaworks.redis	The redis client package containing `RedisClient` for regular and sentinel operations.
com.lambdaworks.redis.api	Standalone Redis connection API.
com.lambdaworks.redis.api.async	Standalone Redis API for asynchronous executed commands.
com.lambdaworks.redis.api.rx	Standalone Redis API for reactive commands.
com.lambdaworks.redis.api.sync	Standalone Redis API for synchronous executed commands.
com.lambdaworks.redis.cluster	Client for redis clusters `RedisClusterClient`.
com.lambdaworks.redis.cluster.api	Redis Cluster connection API.
com.lambdaworks.redis.cluster.api.async	Redis Cluster API for asynchronous executed commands.
com.lambdaworks.redis.cluster.api.rx	Redis Cluster API for reactive commands.
com.lambdaworks.redis.cluster.api.sync	Redis Cluster API for synchronous executed commands.
com.lambdaworks.redis.cluster.event
com.lambdaworks.redis.cluster.models.partitions	Model and parser for the `CLUSTER NODES` and `CLUSTER SLAVES` output.
com.lambdaworks.redis.cluster.models.slots	Model and parser for the `CLUSTER SLOTS` output.
com.lambdaworks.redis.codec	Codecs for key/value type conversion.
com.lambdaworks.redis.event	Event publishing and subscription.
com.lambdaworks.redis.event.connection	Connection-related events.
com.lambdaworks.redis.event.metrics	Metric events and publishing.
com.lambdaworks.redis.masterslave
com.lambdaworks.redis.metrics	Collectors for client metrics.
com.lambdaworks.redis.models.command	Model and parser to for the `COMMAND` and `COMMAND INFO` output.
com.lambdaworks.redis.models.role	Model and parser for the `ROLE` output.
com.lambdaworks.redis.output	Implementation of different output protocols including the Streaming API.
com.lambdaworks.redis.protocol	Redis protocol layer abstraction.
com.lambdaworks.redis.pubsub	Pub/Sub connection classes.
com.lambdaworks.redis.pubsub.api.async	PubSub Redis API for asynchronous executed commands.
com.lambdaworks.redis.pubsub.api.rx	PubSub Redis API for reactive commands.
com.lambdaworks.redis.pubsub.api.sync	PubSub Redis API for synchronous executed commands.
com.lambdaworks.redis.resource	Client resource infrastructure providers.
com.lambdaworks.redis.sentinel	Redis Sentinel connection classes.
com.lambdaworks.redis.sentinel.api	Redis Sentinel connection API.
com.lambdaworks.redis.sentinel.api.async	Redis Sentinel API for asynchronous executed commands.
com.lambdaworks.redis.sentinel.api.rx	Redis Sentinel API for reactive commands.
com.lambdaworks.redis.sentinel.api.sync	Redis Sentinel API for synchronous executed commands.
com.lambdaworks.redis.support	Supportive classes such as `RedisClientCdiBean` for CDI support, `RedisClientFactoryBean` for Spring.

lettuce is a scalable thread-safe Java RedisClient providing synchronous, asynchronous and reactive APIs for Redis Standalone, PubSub, Redis Sentinel and Redis Cluster. Multiple threads may share one connection if they avoid blocking and transactional operations such as BLPOP and MULTI/EXEC. Multiple open connections are efficiently managed by the excellent netty NIO framework.

Each redis command is implemented by one or more methods with names identical to the lowercase redis command name. Complex commands with multiple modifiers that change the result type include the CamelCased modifier as part of the command name, e.g. zrangebyscore and zrangebyscoreWithScores.

Redis connections are designed to be long-lived, and if the connection is lost will reconnect until close() is called. Pending commands that have not timed out will be (re)sent after successful reconnection.

All connections inherit a default timeout from their RedisClient and will throw a RedisException when non-blocking commands fail to return a result before the timeout expires. The timeout defaults to 60 seconds and may be changed via AbstractRedisClient.setDefaultTimeout(long, java.util.concurrent.TimeUnit) or for each individual connection.