redis.clients.jedis

Class Connection

java.lang.Object

redis.clients.jedis.Connection

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

CacheConnection

public class Connection
extends java.lang.Object
implements java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected RedisProtocol	protocol The RESP protocol established for this connection.
protected java.lang.String	server
protected java.lang.String	version

Constructor Summary

Constructors

Modifier	Constructor and Description
	Connection()
protected	Connection(Connection.Builder builder)
	Connection(HostAndPort hostAndPort)
	Connection(HostAndPort hostAndPort, JedisClientConfig clientConfig)
	Connection(JedisSocketFactory socketFactory)
	Connection(JedisSocketFactory socketFactory, JedisClientConfig clientConfig)
	Connection(java.lang.String host, int port)

Method Summary

Modifier and Type	Method and Description
protected void	addPushConsumer(PushConsumer consumer)
static Connection.Builder	builder()
void	close()
void	connect()
void	disconnect() Close the socket and disconnect the server.
protected byte[]	encodeToBytes(char[] chars)
java.lang.Object	executeCommand(CommandArguments args)
<T> T	executeCommand(CommandObject<T> commandObject)
java.lang.Object	executeCommand(ProtocolCommand cmd)
protected void	flush()
void	forceDisconnect()
protected AuthXManager	getAuthXManager()
byte[]	getBinaryBulkReply()
java.util.List<byte[]>	getBinaryMultiBulkReply()
java.lang.String	getBulkReply()
HostAndPort	getHostAndPort() Returns the host and port of the Redis server this connection is connected to.
java.util.List<java.lang.Long>	getIntegerMultiBulkReply()
java.lang.Long	getIntegerReply()
java.util.List<java.lang.Object>	getMany(int count)
java.util.List<java.lang.String>	getMultiBulkReply()
java.util.List<java.lang.Object>	getObjectMultiBulkReply()
java.lang.Object	getOne()
RedisProtocol	getRedisProtocol() Returns the RESP protocol established for this connection.
int	getSoTimeout()
java.lang.String	getStatusCodeReply()
java.lang.Object	getUnflushedObject()
java.util.List<java.lang.Object>	getUnflushedObjectMultiBulkReply() Deprecated. Use getUnflushedObject().
protected java.util.Map<java.lang.String,java.lang.Object>	hello(byte[]... args)
protected void	initializeFromClientConfig(JedisClientConfig config)
protected void	initPushConsumers(JedisClientConfig config)
boolean	isBroken()
boolean	isConnected()
protected boolean	isTokenBasedAuthenticationEnabled()
boolean	ping()
protected java.lang.Object	protocolRead(RedisInputStream is, PushConsumerChain consumer)
protected void	protocolReadPushes(RedisInputStream is, PushConsumerChain consumer)
protected java.lang.Object	readProtocolWithCheckingBroken()
protected void	readPushesWithCheckingBroken()
java.lang.String	reAuthenticate()
void	rollbackTimeout()
java.lang.String	select(int index)
void	sendCommand(CommandArguments args)
void	sendCommand(ProtocolCommand cmd)
void	sendCommand(ProtocolCommand cmd, byte[]... args)
void	sendCommand(ProtocolCommand cmd, Rawable keyword)
void	sendCommand(ProtocolCommand cmd, java.lang.String... args)
void	setBroken()
void	setCredentials(RedisCredentials credentials)
void	setHandlingPool(ConnectionPool pool)
void	setSoTimeout(int soTimeout)
void	setTimeoutInfinite()
java.lang.String	toIdentityString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected RedisProtocol protocol

The RESP protocol established for this connection.

Set after the handshake completes. Holds the protocol the connection is actually speaking with the server.

• null – No protocol established yet (handshake has not run).
• RESP2 – RESP2 established (either explicitly requested, fallback from auto-negotiation, or assumed default when no protocol was requested and auto-negotiation was disabled).
• RESP3 – RESP3 established.

server

protected java.lang.String server

version

protected java.lang.String version

Constructor Detail

Connection

public Connection()

Connection

public Connection(java.lang.String host,
                  int port)

Connection

public Connection(HostAndPort hostAndPort)

Connection

public Connection(HostAndPort hostAndPort,
                  JedisClientConfig clientConfig)

Connection

public Connection(JedisSocketFactory socketFactory)

Connection

public Connection(JedisSocketFactory socketFactory,
                  JedisClientConfig clientConfig)

Connection

protected Connection(Connection.Builder builder)

Method Detail

builder

public static Connection.Builder builder()

initPushConsumers

protected void initPushConsumers(JedisClientConfig config)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toIdentityString

@Experimental
public java.lang.String toIdentityString()

getRedisProtocol

public final RedisProtocol getRedisProtocol()

Returns the RESP protocol established for this connection.

Returns:

null if no protocol has been established yet (handshake has not run); RedisProtocol.RESP2 or RedisProtocol.RESP3 once the handshake has completed.

setHandlingPool

public final void setHandlingPool(ConnectionPool pool)

getHostAndPort

public final HostAndPort getHostAndPort()

Returns the host and port of the Redis server this connection is connected to.

Returns:

the host and port, or null if not available

getSoTimeout

public int getSoTimeout()

setSoTimeout

public void setSoTimeout(int soTimeout)

setTimeoutInfinite

public void setTimeoutInfinite()

rollbackTimeout

public void rollbackTimeout()

executeCommand

public java.lang.Object executeCommand(ProtocolCommand cmd)

executeCommand

public java.lang.Object executeCommand(CommandArguments args)

executeCommand

public <T> T executeCommand(CommandObject<T> commandObject)

sendCommand

public void sendCommand(ProtocolCommand cmd)

sendCommand

public void sendCommand(ProtocolCommand cmd,
                        Rawable keyword)

sendCommand

public void sendCommand(ProtocolCommand cmd,
                        java.lang.String... args)

sendCommand

public void sendCommand(ProtocolCommand cmd,
                        byte[]... args)

sendCommand

public void sendCommand(CommandArguments args)

connect

public void connect()
             throws JedisConnectionException

Throws:

JedisConnectionException

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

disconnect

public void disconnect()

Close the socket and disconnect the server.

forceDisconnect

public void forceDisconnect()
                     throws java.io.IOException

Throws:

java.io.IOException

isConnected

public boolean isConnected()

isBroken

public boolean isBroken()

setBroken

public void setBroken()

getStatusCodeReply

public java.lang.String getStatusCodeReply()

getBulkReply

public java.lang.String getBulkReply()

getBinaryBulkReply

public byte[] getBinaryBulkReply()

getIntegerReply

public java.lang.Long getIntegerReply()

getMultiBulkReply

public java.util.List<java.lang.String> getMultiBulkReply()

getBinaryMultiBulkReply

public java.util.List<byte[]> getBinaryMultiBulkReply()

getUnflushedObjectMultiBulkReply

@Deprecated
public java.util.List<java.lang.Object> getUnflushedObjectMultiBulkReply()

Deprecated. Use getUnflushedObject().

getUnflushedObject

public java.lang.Object getUnflushedObject()

getObjectMultiBulkReply

public java.util.List<java.lang.Object> getObjectMultiBulkReply()

getIntegerMultiBulkReply

public java.util.List<java.lang.Long> getIntegerMultiBulkReply()

getOne

public java.lang.Object getOne()

flush

protected void flush()

protocolRead

@Experimental
protected java.lang.Object protocolRead(RedisInputStream is,
                                                      PushConsumerChain consumer)

protocolReadPushes

@Experimental
protected void protocolReadPushes(RedisInputStream is,
                                                PushConsumerChain consumer)

readProtocolWithCheckingBroken

protected java.lang.Object readProtocolWithCheckingBroken()

readPushesWithCheckingBroken

protected void readPushesWithCheckingBroken()

getMany

public java.util.List<java.lang.Object> getMany(int count)

initializeFromClientConfig

protected void initializeFromClientConfig(JedisClientConfig config)

setCredentials

public void setCredentials(RedisCredentials credentials)

reAuthenticate

public java.lang.String reAuthenticate()

hello

protected java.util.Map<java.lang.String,java.lang.Object> hello(byte[]... args)

encodeToBytes

protected byte[] encodeToBytes(char[] chars)

select

public java.lang.String select(int index)

ping

public boolean ping()

isTokenBasedAuthenticationEnabled

protected boolean isTokenBasedAuthenticationEnabled()

getAuthXManager

protected AuthXManager getAuthXManager()

addPushConsumer

@Internal
protected void addPushConsumer(PushConsumer consumer)