CCF
Loading...
Searching...
No Matches
Functions
metadata

Functions

virtual void ccf::RpcContext::set_apply_writes (bool apply)=0
 
virtual void ccf::RpcContext::set_claims_digest (ccf::ClaimsDigest::Digest &&digest)=0
 
virtual void ccf::RpcContext::set_consensus_committed_function (ccf::endpoints::ConsensusCommittedEndpointFunction func)=0
 

Detailed Description

Methods which affect how the framework processes this transaction.

Function Documentation

◆ set_apply_writes()

virtual void ccf::RpcContext::set_apply_writes ( bool  apply)
pure virtual

Tells the framework to apply or not apply this transaction. By default that decision is based on the response status, with successes applied and errors producing no persistent writes. This value will override, allowing changes to be persisted/dropped regardless of response type.

Implemented in http::HttpRpcContext.

◆ set_claims_digest()

virtual void ccf::RpcContext::set_claims_digest ( ccf::ClaimsDigest::Digest &&  digest)
pure virtual

Sets the application claims digest associated with this transaction. This digest is used to construct the Merkle tree leaf representing this transaction. This allows a transaction to make specific, separately-revealable claims in each transaction, without being bound to the transaction serialisation format or what is stored in the KV. The digest will be included in receipts issued for that transaction.

Implemented in ccf::RpcContextImpl.

◆ set_consensus_committed_function()

virtual void ccf::RpcContext::set_consensus_committed_function ( ccf::endpoints::ConsensusCommittedEndpointFunction  func)
pure virtual

Tells the framework to hold the response for this request until the transaction reaches a terminal consensus state (committed or invalidated). The provided callback will be invoked with a CommittedTxInfo describing the outcome, and may inspect or modify the response before it is sent to the client. If this method is not called during endpoint execution, the response is sent immediately after local commit.

Implemented in ccf::RpcContextImpl.