class BroadcastTransactionProtocol : ProtocolLogic<Unit>
Notify all involved parties about a transaction, including storing a copy. Normally this would be called via FinalityProtocol.
notarisedTransaction
- transaction which has been notarised (if needed) and is ready to notify nodes about.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.
NotifyTxRequestMessage |
data class NotifyTxRequestMessage : PartyRequestMessage |
<init> |
BroadcastTransactionProtocol(notarisedTransaction: SignedTransaction, events: Set<ClientToServiceCommand>, participants: Set<Party>) Notify all involved parties about a transaction, including storing a copy. Normally this would be called via FinalityProtocol. |
events |
val events: Set<ClientToServiceCommand> |
notarisedTransaction |
val notarisedTransaction: SignedTransaction |
participants |
val participants: Set<Party> |
topic |
val topic: String The topic to use when communicating with other parties. If more than one topic is required then use sub-protocols. Note that this is temporary until protocol sessions are properly implemented. |
logger |
val logger: <ERROR CLASS> This is where you should log things to. |
progressTracker |
open 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. |
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. |
receive |
fun <T : Any> receive(sessionIDForReceive: Long): UntrustworthyData<T> fun <T : Any> receive(sessionIDForReceive: Long, receiveType: Class<T>): UntrustworthyData<T> |
send |
fun send(destination: Party, sessionID: Long, payload: Any): Unit |
sendAndReceive |
fun <T : Any> sendAndReceive(destination: Party, sessionIDForSend: Long, sessionIDForReceive: Long, payload: Any): UntrustworthyData<T> |
subProtocol |
fun <R> subProtocol(subLogic: ProtocolLogic<R>): R Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the ProtocolStateMachine and then calling the call method. |
TOPIC |
val TOPIC: String Topic for messages notifying a node of a new transaction |