Command (xmemcached 2.4.7 API)

java.lang.Object
- net.rubyeye.xmemcached.command.Command

All Implemented Interfaces:

WriteMessage

Direct Known Subclasses:

BaseBinaryCommand, TextAWSElasticCacheConfigCommand, TextCacheDumpCommand, TextDeleteCommand, TextFlushAllCommand, TextGetCommand, TextIncrDecrCommand, TextQuitCommand, TextStatsCommand, TextStoreCommand, TextTouchCommand, TextVersionCommand, VerbosityCommand
```
public abstract class Command
extends Object
implements WriteMessage
```
Abstract Memcached Command

Author:

dennis

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`cancel`
`protected CommandType`	`commandType`
`protected Exception`	`exception`
`protected IoBuffer`	`ioBuffer`
`protected String`	`key`
`protected byte[]`	`keyBytes`
`protected CountDownLatch`	`latch`
`protected int`	`mergeCount`
`protected boolean`	`noreply`
`static byte`	`REQUEST_MAGIC_NUMBER`
`static byte`	`RESPONSE_MAGIC_NUMBER`
`protected Object`	`result`
`protected OperationStatus`	`status`
`protected Transcoder`	`transcoder`
`protected FutureImpl<Boolean>`	`writeFuture`

Constructor Summary

Constructors
Constructor and Description
`Command()`
`Command(CommandType cmdType)`
`Command(CommandType cmdType, CountDownLatch latch)`
`Command(String key, byte[] keyBytes, CommandType cmdType, CountDownLatch latch)`
`Command(String key, byte[] keyBytes, CountDownLatch latch)`
`Command(String key, CommandType commandType, CountDownLatch latch)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancel()`
`void`	`countDownLatch()`
`abstract boolean`	`decode(MemcachedTCPSession session, ByteBuffer buffer)`
`protected void`	`decodeError()`
`protected boolean`	`decodeError(Session session, ByteBuffer buffer)`
`protected boolean`	`decodeError(String line)`
`protected void`	`decodeError(String msg, Throwable e)`
`abstract void`	`encode()`
`CommandType`	`getCommandType()`
`int`	`getCopiedMergeCount()`
`Exception`	`getException()`
`IoBuffer`	`getIoBuffer()`
`String`	`getKey()`
`byte[]`	`getKeyBytes()`
`CountDownLatch`	`getLatch()`
`int`	`getMergeCount()`
`Object`	`getMessage()`
`Object`	`getResult()`
`OperationStatus`	`getStatus()`
`Transcoder`	`getTranscoder()`
`IoBuffer`	`getWriteBuffer()`
`FutureImpl<Boolean>`	`getWriteFuture()`
`boolean`	`isAdded()`
`boolean`	`isCancel()`
`boolean`	`isNoreply()`
`boolean`	`isWriting()`
`void`	`setAdded(boolean added)`
`void`	`setCommandType(CommandType commandType)`
`void`	`setException(Exception throwable)`
`void`	`setIoBuffer(IoBuffer ioBuffer)`
`void`	`setKey(String key)`
`void`	`setKeyBytes(byte[] keyBytes)`
`void`	`setLatch(CountDownLatch latch)`
`void`	`setMergeCount(int mergetCount)`
`void`	`setNoreply(boolean noreply)`
`void`	`setResult(Object result)`
`void`	`setStatus(OperationStatus status)`
`void`	`setTranscoder(Transcoder transcoder)`
`void`	`setWriteBuffer(IoBuffer buffers)`
`void`	`setWriteFuture(FutureImpl<Boolean> writeFuture)`
`String`	`toString()`
`void`	`writing()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REQUEST_MAGIC_NUMBER
```
public static final byte REQUEST_MAGIC_NUMBER
```
See Also:
Constant Field Values

RESPONSE_MAGIC_NUMBER
```
public static final byte RESPONSE_MAGIC_NUMBER
```
See Also:
Constant Field Values

key
```
protected String key
```

keyBytes
```
protected byte[] keyBytes
```

result
```
protected Object result
```

latch
```
protected CountDownLatch latch
```

commandType
```
protected CommandType commandType
```

exception
```
protected Exception exception
```

ioBuffer
```
protected IoBuffer ioBuffer
```

cancel
```
protected volatile boolean cancel
```

status
```
protected OperationStatus status
```

mergeCount
```
protected int mergeCount
```

transcoder
```
protected Transcoder transcoder
```

noreply
```
protected boolean noreply
```

writeFuture

protected FutureImpl<Boolean> writeFuture

Constructor Detail

Command
```
public Command()
```

Command

public Command(String key,
       byte[] keyBytes,
       CountDownLatch latch)

Command

public Command(String key,
       byte[] keyBytes,
       CommandType cmdType,
       CountDownLatch latch)

Command
```
public Command(CommandType cmdType)
```

Command

public Command(CommandType cmdType,
       CountDownLatch latch)

Command

public Command(String key,
       CommandType commandType,
       CountDownLatch latch)

Method Detail

isAdded
```
public boolean isAdded()
```

setAdded
```
public void setAdded(boolean added)
```

getMessage
```
public final Object getMessage()
```
Specified by:

getMessage in interface WriteMessage

getWriteBuffer
```
public final IoBuffer getWriteBuffer()
```
Specified by:

getWriteBuffer in interface WriteMessage

setWriteBuffer
```
public void setWriteBuffer(IoBuffer buffers)
```
Specified by:

setWriteBuffer in interface WriteMessage

getKeyBytes
```
public final byte[] getKeyBytes()
```

setKeyBytes

public final void setKeyBytes(byte[] keyBytes)

setCommandType

public void setCommandType(CommandType commandType)

getMergeCount
```
public int getMergeCount()
```

getTranscoder
```
public Transcoder getTranscoder()
```

setTranscoder

public void setTranscoder(Transcoder transcoder)

setMergeCount

public void setMergeCount(int mergetCount)

getCopiedMergeCount
```
public int getCopiedMergeCount()
```

getStatus
```
public OperationStatus getStatus()
```

setStatus

public final void setStatus(OperationStatus status)

setIoBuffer

public final void setIoBuffer(IoBuffer ioBuffer)

getException
```
public Exception getException()
```

setException

public void setException(Exception throwable)

getKey
```
public final String getKey()
```

setKey
```
public final void setKey(String key)
```

getResult
```
public final Object getResult()
```

setResult

public final void setResult(Object result)

getIoBuffer
```
public final IoBuffer getIoBuffer()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

isCancel
```
public boolean isCancel()
```

cancel
```
public final void cancel()
```

getLatch

public final CountDownLatch getLatch()

countDownLatch
```
public final void countDownLatch()
```

getCommandType

public final CommandType getCommandType()

setLatch

public final void setLatch(CountDownLatch latch)

encode
```
public abstract void encode()
```

decode

public abstract boolean decode(MemcachedTCPSession session,
             ByteBuffer buffer)

decodeError

protected final void decodeError(String msg,
               Throwable e)

decodeError
```
protected final void decodeError()
```

decodeError

protected final boolean decodeError(String line)

decodeError

protected final boolean decodeError(Session session,
                  ByteBuffer buffer)

isNoreply
```
public final boolean isNoreply()
```

setNoreply

public final void setNoreply(boolean noreply)

getWriteFuture
```
public FutureImpl<Boolean> getWriteFuture()
```
Specified by:

getWriteFuture in interface WriteMessage

setWriteFuture

public final void setWriteFuture(FutureImpl<Boolean> writeFuture)

isWriting
```
public final boolean isWriting()
```
Specified by:

isWriting in interface WriteMessage

writing
```
public final void writing()
```
Specified by:

writing in interface WriteMessage

Class Command

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_MAGIC_NUMBER

RESPONSE_MAGIC_NUMBER

key

keyBytes

result

latch

commandType

exception

ioBuffer

cancel

status

mergeCount

transcoder

noreply

writeFuture

Constructor Detail

Command

Command

Command

Command

Command

Command

Method Detail

isAdded

setAdded

getMessage

getWriteBuffer

setWriteBuffer

getKeyBytes

setKeyBytes

setCommandType

getMergeCount

getTranscoder

setTranscoder

setMergeCount

getCopiedMergeCount

getStatus

setStatus

setIoBuffer

getException

setException

getKey

setKey

getResult

setResult

getIoBuffer

toString

isCancel

cancel

getLatch

countDownLatch

getCommandType

setLatch

encode

decode

decodeError

decodeError

decodeError

decodeError

isNoreply

setNoreply

getWriteFuture

setWriteFuture

isWriting

writing