class FinalityProtocol : ProtocolLogic<Unit>
Finalise a transaction by notarising it, then recording it locally, and then sending it to all involved parties.
transaction
- to commit.events
- information on the event(s) which triggered the transaction.participants
- a list of participants involved in the transaction.Return
a list of participants who were successfully notified of the transaction.
BROADCASTING |
object BROADCASTING : Step |
NOTARISING |
object NOTARISING : Step |
<init> |
FinalityProtocol(transaction: SignedTransaction, events: Set<ClientToServiceCommand>, participants: Set<Party>, progressTracker: ProgressTracker = tracker()) Finalise a transaction by notarising it, then recording it locally, and then sending it to all involved parties. |
events |
val events: Set<ClientToServiceCommand> |
participants |
val participants: Set<Party> |
progressTracker |
val progressTracker: ProgressTracker Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track progress. |
transaction |
val transaction: SignedTransaction |
logger |
val logger: <ERROR CLASS> This is where you should log things to. |
psm |
lateinit var psm: ProtocolStateMachine<*> Reference to the Fiber instance that is the top level controller for the entire flow. |
serviceHub |
val serviceHub: ServiceHub Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts. It is only available once the protocol has started, which means it cannnot be accessed in the constructor. Either access this lazily or from inside call. |
call |
fun call(): Unit This is where you fill out your business logic. |
getCounterpartyMarker |
open fun getCounterpartyMarker(party: Party): Class<*> Return the marker Class which party has used to register the counterparty protocol that is to execute on the other side. The default implementation returns the class object of this ProtocolLogic, but any Class instance will do as long as the other side registers with it. |
receive |
fun <T : Any> receive(otherParty: Party, receiveType: Class<T>): UntrustworthyData<T> fun <T : Any> receive(otherParty: Party): UntrustworthyData<T> |
send |
fun send(otherParty: Party, payload: Any): Unit |
sendAndReceive |
fun <T : Any> sendAndReceive(otherParty: Party, payload: Any): UntrustworthyData<T> fun <T : Any> sendAndReceive(otherParty: Party, payload: Any, receiveType: Class<T>): UntrustworthyData<T> |
subProtocol |
fun <R> subProtocol(subLogic: ProtocolLogic<R>, : Boolean = false): R Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the ProtocolStateMachine and then calling the call method. |
track |
fun track(): <ERROR CLASS><String, <ERROR CLASS><String>>? |
tracker |
fun tracker(): ProgressTracker |