org.jredis.protocol

Interface Protocol

All Known Implementing Classes:

ConcurrentSyncProtocol, ProtocolBase, SyncProtocol

public interface Protocol

Protocol is effectively a Message factory. Implementations of this interface provides Message objects that read and write according to a specific Redis protocol specification.

Implementations may use this interface to address issues regarding buffer management. [TODO: document me!]

Since:

alpha.0

Version:

alpha.0, 04/02/09

Author:

Joubin Houshyar (alphazero@sensesay.net)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Protocol.Factory

Method Summary

Modifier and Type	Method and Description
Request	createRequest(Command cmd, byte[]... args)
byte[]	createRequestBuffer(Command cmd, byte[]... args) EXPERIMENTAL
Response	createResponse(Command cmd) Creates a response object for the Command specified.
boolean	isCompatibleWithVersion(String version)

Method Detail

isCompatibleWithVersion

boolean isCompatibleWithVersion(String version)

Parameters:

version -

Returns:

createRequest

Request createRequest(Command cmd,
                      byte[]... args)
               throws ProviderException,
                      IllegalArgumentException

Parameters:

cmd -

args -

Returns:

Throws:

ProviderException

IllegalArgumentException

createResponse

Response createResponse(Command cmd)
                 throws ProviderException,
                        ClientRuntimeException

Creates a response object for the Command specified.

Note that this Response object has not yet been read.

Parameters:

cmd - the Command that will be responded to.

Returns:

the response object that is ready to be read from the network connection.

Throws:

ClientRuntimeException - if the command is invalid for this version of the protocol

ProviderException - if the command is not implemented

See Also:

Response

createRequestBuffer

byte[] createRequestBuffer(Command cmd,
                           byte[]... args)
                    throws ProviderException,
                           IllegalArgumentException

EXPERIMENTAL

Parameters:

cmd -

args -

Returns:

Throws:

ProviderException

IllegalArgumentException