redis.clients.jedis

Enum RedisProtocol

java.lang.Object

java.lang.Enum<RedisProtocol>

redis.clients.jedis.RedisProtocol

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RedisProtocol>

public enum RedisProtocol
extends java.lang.Enum<RedisProtocol>

Enum representing the Redis protocol version to use when connecting to a Redis server.

Three modes are supported:

• null – combined with JedisClientConfig.isAutoNegotiateProtocol() the client either skips the HELLO command altogether (auto-negotiation disabled, legacy Jedis behaviour) or attempts HELLO 3 with a graceful RESP2 fallback (auto-negotiation enabled, the default for UnifiedJedis-based clients).
• RESP2 – sends a HELLO 2 command requesting RESP2; the connection fails if the server rejects the request.
• RESP3 – sends a HELLO 3 command requesting RESP3; the connection fails if the server rejects the request.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RESP2
RESP3

Field Summary

Fields

Modifier and Type	Field and Description
static RedisProtocol	REDIS_SERVER_DEFAULT_PROTO

Method Summary

Modifier and Type	Method and Description
static RedisProtocol	from(java.lang.Long proto) Returns the RedisProtocol enum value corresponding to the given protocol version number.
static RedisProtocol	orServerDefault(RedisProtocol proto)
static RedisProtocol	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RedisProtocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
java.lang.String	version()

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESP2

public static final RedisProtocol RESP2

RESP3

public static final RedisProtocol RESP3

Field Detail

REDIS_SERVER_DEFAULT_PROTO

public static final RedisProtocol REDIS_SERVER_DEFAULT_PROTO

Method Detail

values

public static RedisProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RedisProtocol c : RedisProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RedisProtocol valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

version

public java.lang.String version()

from

public static RedisProtocol from(java.lang.Long proto)

Returns the RedisProtocol enum value corresponding to the given protocol version number.

Parameters:

proto - the protocol version number (2 or 3)

Returns:

the corresponding RedisProtocol enum value

Throws:

JedisProtocolNotSupportedException - if the protocol version is not recognized

orServerDefault

public static RedisProtocol orServerDefault(RedisProtocol proto)