CommitRequest (JSimpleDB Raft Key/Value Store 2.4.1 API)

java.lang.Object
- org.jsimpledb.kv.raft.msg.Message
- - org.jsimpledb.kv.raft.msg.CommitRequest

```
public class CommitRequest
extends Message
```
Sent from followers to leaders to start the commit of a transaction.

Constructor Summary

Constructors
Constructor and Description
`CommitRequest(int clusterId, String senderId, String recipientId, long term, long txId, long baseTerm, long baseIndex, ByteBuffer readsData, ByteBuffer mutationData)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`calculateSize()` Calculate an upper bound on the number of bytes required by `writeTo()`.
`long`	`getBaseIndex()`
`long`	`getBaseTerm()`
`ByteBuffer`	`getMutationData()` Get the transaction's mutations.
`ByteBuffer`	`getReadsData()`
`long`	`getTxId()`
`boolean`	`isReadOnly()` Determine whether this is a read-only transaction.
`String`	`toString()`
`void`	`visit(MessageSwitch handler)` Apply the visitor pattern based on this instance's type.
`void`	`writeTo(ByteBuffer dest)` Serialize this instance into the given buffer.

Methods inherited from class org.jsimpledb.kv.raft.msg.Message
calculateSize, calculateSize, calculateSize, decode, encode, getBoolean, getByteBuffer, getClusterId, getReads, getRecipientId, getSenderId, getString, getTerm, getTimestamp, getWrites, isLeaderMessage, putBoolean, putByteBuffer, putReads, putString, putTimestamp, putWrites

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

- Constructor Detail
  - CommitRequest
```
public CommitRequest(int clusterId,
             String senderId,
             String recipientId,
             long term,
             long txId,
             long baseTerm,
             long baseIndex,
             ByteBuffer readsData,
             ByteBuffer mutationData)
```
    Constructor.
    
    Parameters:
    clusterId - cluster ID
    senderId - identity of sender
    recipientId - identity of recipient
    term - sender's current term
    txId - sender's transaction ID
    baseTerm - term of the log entry on which the transaction is based
    baseIndex - index of the log entry on which the transaction is based
    readsData - keys read during the transaction
    mutationData - transaction mutations, or null for none
- Method Detail
  - getTxId
```
public long getTxId()
```
  - getBaseTerm
```
public long getBaseTerm()
```
  - getBaseIndex
```
public long getBaseIndex()
```
  - getReadsData
```
public ByteBuffer getReadsData()
```
  - isReadOnly
```
public boolean isReadOnly()
```
    Determine whether this is a read-only transaction.
    
    Returns:
    true if there is no writes data, otherwise false
    
    Throws:
    
    IllegalStateException - if getMutationData() has already been invoked
  - getMutationData
```
public ByteBuffer getMutationData()
```
    Get the transaction's mutations.
    This method may only be invoked once.
    
    Returns:
    transaction mutations, or null if transaction is read-only
    
    Throws:
    
    IllegalStateException - if this method has already been invoked
  - visit
```
public void visit(MessageSwitch handler)
```
    Description copied from class: Message
    
    Apply the visitor pattern based on this instance's type.
    
    Specified by:
    
    visit in class Message
    
    Parameters:
    handler - target for visit
  - writeTo
```
public void writeTo(ByteBuffer dest)
```
    Description copied from class: Message
    
    Serialize this instance into the given buffer.
    
    Overrides:
    
    writeTo in class Message
    
    Parameters:
    dest - destination for encoded data
  - calculateSize
```
protected int calculateSize()
```
    Description copied from class: Message
    
    Calculate an upper bound on the number of bytes required by writeTo().
    
    Overrides:
    
    calculateSize in class Message
    
    Returns:
    an upper bound on the number of encoded bytes
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class Message

Class CommitRequest

Constructor Summary

Method Summary

Methods inherited from class org.jsimpledb.kv.raft.msg.Message

Methods inherited from class java.lang.Object

Constructor Detail

CommitRequest

Method Detail

getTxId

getBaseTerm

getBaseIndex

getReadsData

isReadOnly

getMutationData

visit

writeTo

calculateSize

toString