io.lettuce.core.protocol

Class RedisStateMachine

java.lang.Object

io.lettuce.core.protocol.RedisStateMachine

public class RedisStateMachine
extends Object

State machine that decodes redis server responses encoded according to the Unified Request Protocol (RESP).

Author:

Will Glozer, Mark Paluch, Helly Guo

Constructor Summary

Constructors

Constructor and Description
RedisStateMachine() Initialize a new instance.

Method Summary

Modifier and Type	Method and Description
void	close() Close the state machine to free resources.
boolean	decode(ByteBuf buffer, CommandOutput<?,?,?> output) Decode a command using the input buffer.
boolean	decode(ByteBuf buffer, RedisCommand<?,?,?> command, CommandOutput<?,?,?> output) Attempt to decode a redis response and return a flag indicating whether a complete response was read.
void	reset() Reset the state machine.
protected void	safeMulti(CommandOutput<?,?,?> output, int count, RedisCommand<?,?,?> command) Safely sets CommandOutput.multi(int).
protected void	safeSet(CommandOutput<?,?,?> output, ByteBuffer bytes, RedisCommand<?,?,?> command) Safely sets CommandOutput.set(ByteBuffer).
protected void	safeSet(CommandOutput<?,?,?> output, long integer, RedisCommand<?,?,?> command) Safely sets CommandOutput.set(long).
protected void	safeSetError(CommandOutput<?,?,?> output, ByteBuffer bytes, RedisCommand<?,?,?> command) Safely sets CommandOutput.setError(ByteBuffer).
protected void	safeSetSingle(CommandOutput<?,?,?> output, ByteBuffer bytes, RedisCommand<?,?,?> command) Safely sets CommandOutput.set(ByteBuffer).

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisStateMachine

public RedisStateMachine()

Initialize a new instance.

Method Detail

decode

public boolean decode(ByteBuf buffer,
                      CommandOutput<?,?,?> output)

Decode a command using the input buffer.

Parameters:

buffer - Buffer containing data from the server.

output - Current command output.

Returns:

true if a complete response was read.

decode

public boolean decode(ByteBuf buffer,
                      RedisCommand<?,?,?> command,
                      CommandOutput<?,?,?> output)

Attempt to decode a redis response and return a flag indicating whether a complete response was read.

Parameters:

buffer - Buffer containing data from the server.

command - the command itself

output - Current command output.

Returns:

true if a complete response was read.

reset

public void reset()

Reset the state machine.

close

public void close()

Close the state machine to free resources.

safeSet

protected void safeSet(CommandOutput<?,?,?> output,
                       long integer,
                       RedisCommand<?,?,?> command)

Safely sets CommandOutput.set(long). Completes a command exceptionally in case an exception occurs.

Parameters:

output -

integer -

command -

safeSet

protected void safeSet(CommandOutput<?,?,?> output,
                       ByteBuffer bytes,
                       RedisCommand<?,?,?> command)

Safely sets CommandOutput.set(ByteBuffer). Completes a command exceptionally in case an exception occurs.

Parameters:

output -

bytes -

command -

safeSetSingle

protected void safeSetSingle(CommandOutput<?,?,?> output,
                             ByteBuffer bytes,
                             RedisCommand<?,?,?> command)

Safely sets CommandOutput.set(ByteBuffer). Completes a command exceptionally in case an exception occurs.

Parameters:

output -

bytes -

command -

safeMulti

protected void safeMulti(CommandOutput<?,?,?> output,
                         int count,
                         RedisCommand<?,?,?> command)

Safely sets CommandOutput.multi(int). Completes a command exceptionally in case an exception occurs.

Parameters:

output -

count -

command -

safeSetError

protected void safeSetError(CommandOutput<?,?,?> output,
                            ByteBuffer bytes,
                            RedisCommand<?,?,?> command)

Safely sets CommandOutput.setError(ByteBuffer). Completes a command exceptionally in case an exception occurs.

Parameters:

output -

bytes -

command -