Package-level declarations¶
Types¶
| Name | Summary |
|---|---|
| DeferredRedis | [jvm] interface DeferredRedis Like Redis, but returns Suppliers to defer value retrieval. Does not support transactions or pubsub. |
| RealRedis | [jvm] class RealRedis(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics) : Redis For each command, a Jedis instance is retrieved from the pool and returned once the command has been issued. |
| Redis | [jvm] interface Redis A Redis client. |
| RedisClientMetrics | [jvm] @Singleton class RedisClientMetrics@Injectconstructor(ticker: Ticker, metrics: Metrics) |
| RedisClusterConfig | [jvm] class RedisClusterConfig : LinkedHashMap<String, RedisClusterReplicationGroupConfig> , Config Top-level configuration element for all redis clusters |
| RedisClusterModule | [jvm] class RedisClusterModule@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule Configures a Redis client that interacts with a Redis cluster. This also installs a ServiceModule for RedisService. |
| RedisClusterReplicationGroupConfig | [jvm] data class RedisClusterReplicationGroupConfig@JvmOverloadsconstructor(val configuration_endpoint: RedisNodeConfig, val client_name: String? = null, val max_attempts: Int = DEFAULT_MAX_ATTEMPTS, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT) Configuration element for a Redis Cluster |
| RedisConfig | [jvm] class RedisConfig : LinkedHashMap<String, RedisReplicationGroupConfig> , Config |
| RedisConnectionException | [jvm] class RedisConnectionException(cluster: String, cause: Throwable) : RuntimeException |
| RedisModule | [jvm] class RedisModule@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule Configures a Redis client with metrics, this also installs a ServiceModule for RedisService. If other services require a working client connection to Redis before they can be used, specify a dependency like: |
| RedisNodeConfig | [jvm] data class RedisNodeConfig(val hostname: String?, val port: Int) |
| RedisReplicationGroupConfig | [jvm] data class RedisReplicationGroupConfig@JvmOverloadsconstructor(val writer_endpoint: RedisNodeConfig, val reader_endpoint: RedisNodeConfig, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT) |
| RedisService | [jvm] @Singleton class RedisService : AbstractIdleService Controls the connection lifecycle for Redis. |
Functions¶
| Name | Summary |
|---|---|
| checkHrandFieldCount | [jvm] inline fun checkHrandFieldCount(count: Long) Validates count is positive and non-zero. This is to avoid unexpected behaviour due to limitations in Jedis: https://github.com/redis/jedis/issues/3017 |