org.jredis.ri.alphazero.protocol

Class ProtocolBase

java.lang.Object

org.jredis.ri.alphazero.protocol.ProtocolBase

All Implemented Interfaces:

Protocol

Direct Known Subclasses:

SyncProtocol

public abstract class ProtocolBase
extends Object
implements Protocol

[TODO: document me!]

Since:

alpha.0

Version:

alpha.0, Apr 10, 2009

Author:

Joubin (alphazero@sensesay.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolBase.StreamBufferRequest SimpleRequest implements the required Message.read(InputStream) using a (likely) shared data buffer.

Nested classes/interfaces inherited from interface org.jredis.protocol.Protocol

Protocol.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ASCII_ZERO
static byte	COUNT_BYTE
static byte[]	CRLF
static int	CRLF_LEN
static int	DELIMETER_LEN
static byte	ERR_BYTE
static byte	NUM_BYTE
static byte	OK_BYTE
static byte	SIZE_BYTE
static byte[]	SPACE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolBase()

Method Summary

Modifier and Type	Method and Description
protected abstract Response	createBooleanResponse(Command cmd)
protected abstract Response	createBulkResponse(Command cmd)
protected abstract Response	createMultiBulkResponse(Command cmd)
protected abstract Response	createNumberResponse(Command cmd)
protected abstract Request	createRequest(ByteArrayOutputStream buffer)
Request	createRequest(Command cmd, byte[]... args)
byte[]	createRequestBuffer(Command cmd, byte[]... args) EXPERIMENTAL
protected abstract ByteArrayOutputStream	createRequestBufffer(Command cmd)
Response	createResponse(Command cmd) Creates a response object for the Command specified.
protected abstract Response	createStatusResponse(Command cmd)
protected abstract Response	createStringResponse(Command cmd)
boolean	isCompatibleWithVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

CRLF

public static final byte[] CRLF

SPACE

public static final byte[] SPACE

CRLF_LEN

public static final int CRLF_LEN

DELIMETER_LEN

public static final int DELIMETER_LEN

ERR_BYTE

public static final byte ERR_BYTE

See Also:

Constant Field Values

OK_BYTE

public static final byte OK_BYTE

See Also:

Constant Field Values

COUNT_BYTE

public static final byte COUNT_BYTE

See Also:

Constant Field Values

SIZE_BYTE

public static final byte SIZE_BYTE

See Also:

Constant Field Values

NUM_BYTE

public static final byte NUM_BYTE

See Also:

Constant Field Values

ASCII_ZERO

public static final byte ASCII_ZERO

See Also:

Constant Field Values

Constructor Detail

ProtocolBase

protected ProtocolBase()

Method Detail

isCompatibleWithVersion

public boolean isCompatibleWithVersion(String version)

Specified by:

isCompatibleWithVersion in interface Protocol

Returns:

createRequestBuffer

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

Description copied from interface: Protocol

EXPERIMENTAL

Specified by:

createRequestBuffer in interface Protocol

Returns:

Throws:

ProviderException

IllegalArgumentException

createRequest

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

Specified by:

createRequest in interface Protocol

Returns:

Throws:

ProviderException

IllegalArgumentException

createResponse

public Response createResponse(Command cmd)
                        throws ProviderException,
                               ClientRuntimeException

Description copied from interface: Protocol

Creates a response object for the Command specified.

Note that this Response object has not yet been read.

Specified by:

createResponse in interface Protocol

Parameters:

cmd - the Command that will be responded to.

Returns:

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

Throws:

ProviderException - if the command is not implemented

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

See Also:

Response

createRequestBufffer

protected abstract ByteArrayOutputStream createRequestBufffer(Command cmd)

createRequest

protected abstract Request createRequest(ByteArrayOutputStream buffer)

createMultiBulkResponse

protected abstract Response createMultiBulkResponse(Command cmd)

createBulkResponse

protected abstract Response createBulkResponse(Command cmd)

createNumberResponse

protected abstract Response createNumberResponse(Command cmd)

createBooleanResponse

protected abstract Response createBooleanResponse(Command cmd)

createStringResponse

protected abstract Response createStringResponse(Command cmd)

createStatusResponse

protected abstract Response createStatusResponse(Command cmd)