Struct tikv::storage::txn::commands::TxnHeartBeat

pub struct TxnHeartBeat {
    pub ctx: Context,
    pub primary_key: Key,
    pub start_ts: TimeStamp,
    pub advise_ttl: u64,
}

Heart beat of a transaction. It enlarges the primary lock’s TTL.

This is invoked on a transaction’s primary lock. The lock may be generated by either AcquirePessimisticLock or Prewrite.

Fields

ctx: Context

primary_key: Key

The primary key of the transaction.

start_ts: TimeStamp

The transaction’s start_ts.

advise_ttl: u64

The new TTL that will be used to update the lock’s TTL. If the lock’s TTL is already greater than advise_ttl, nothing will happen.

Implementations

impl TxnHeartBeat

pub fn new(
    primary_key: Key,
    start_ts: TimeStamp,
    advise_ttl: u64,
    ctx: Context
) -> TypedCommand<TxnStatus>

Return a TypedCommand that encapsulates the result of executing this command.

Trait Implementations

impl CommandExt for TxnHeartBeat

fn get_ctx(&self) -> &Context

fn get_ctx_mut(&mut self) -> &mut Context

fn tag(&self) -> CommandKind

fn incr_cmd_metric(&self)

fn ts(&self) -> TimeStamp

fn write_bytes(&self) -> usize

fn gen_lock(&self) -> Lock

fn readonly(&self) -> bool

fn is_sys_cmd(&self) -> bool

fn can_be_pipelined(&self) -> bool

impl Debug for TxnHeartBeat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TxnHeartBeat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Snapshot, L: LockManager> WriteCommand<S, L> for TxnHeartBeat

fn process_write(
    self,
    snapshot: S,
    context: WriteContext<'_, L>
) -> Result<WriteResult>