io.lettuce.core.output

Class ReplayOutput<K,V>

java.lang.Object

io.lettuce.core.output.CommandOutput<K,V,List<ReplayOutput.Signal>>

io.lettuce.core.output.ReplayOutput<K,V>

public class ReplayOutput<K,V>
extends CommandOutput<K,V,List<ReplayOutput.Signal>>

Replayable CommandOutput capturing output signals to replay these on a target CommandOutput. Replay is useful when the response requires inspection prior to dispatching the actual output to a command target.

Since:

5.0.3

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplayOutput.BulkString
static class	ReplayOutput.ErrorBytes
static class	ReplayOutput.Signal Encapsulates a replayable decoding signal.

Field Summary

Fields inherited from class io.lettuce.core.output.CommandOutput

codec, error, output

Constructor Summary

Constructors

Constructor and Description
ReplayOutput() Initialize a new instance that encodes and decodes keys and values using the supplied codec.

Method Summary

Modifier and Type	Method and Description
void	complete(int depth) Mark the command output complete.
void	multi(int count) Mark the beginning of a multi sequence (array).
void	replay(CommandOutput<?,?,?> target) Replay all captured signals on a CommandOutput.
void	set(ByteBuffer bytes) Set the command output to a sequence of bytes, or null.
void	set(long integer) Set the command output to a 64-bit signed integer.
void	setError(ByteBuffer error) Set command output to an error message from the server.
void	setError(String error) Set command output to an error message from the client.

Methods inherited from class io.lettuce.core.output.CommandOutput

decodeAscii, get, getError, hasError, setSingle, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplayOutput

public ReplayOutput()

Initialize a new instance that encodes and decodes keys and values using the supplied codec.

Method Detail

set

public void set(ByteBuffer bytes)

Description copied from class: CommandOutput

Set the command output to a sequence of bytes, or null. Concrete CommandOutput implementations must override this method unless they only receive an integer value which cannot be null.

Overrides:

set in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

bytes - The command output, or null.

set

public void set(long integer)

Description copied from class: CommandOutput

Set the command output to a 64-bit signed integer. Concrete CommandOutput implementations must override this method unless they only receive a byte array value.

Overrides:

set in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

integer - The command output.

setError

public void setError(ByteBuffer error)

Description copied from class: CommandOutput

Set command output to an error message from the server.

Overrides:

setError in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

error - Error message.

setError

public void setError(String error)

Description copied from class: CommandOutput

Set command output to an error message from the client.

Overrides:

setError in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

error - Error message.

complete

public void complete(int depth)

Description copied from class: CommandOutput

Mark the command output complete.

Overrides:

complete in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

depth - Remaining depth of output queue.

multi

public void multi(int count)

Description copied from class: CommandOutput

Mark the beginning of a multi sequence (array).

Overrides:

multi in class CommandOutput<K,V,List<ReplayOutput.Signal>>

Parameters:

count - expected number of elements in this multi sequence.

replay

public void replay(CommandOutput<?,?,?> target)

Replay all captured signals on a CommandOutput.

Parameters:

target - the target CommandOutput.