com.r3corda.protocols / AbstractStateReplacementProtocol / Instigator

Instigator

abstract class Instigator<out S : ContractState, T> : ProtocolLogic<StateAndRef<S>>


Types

NOTARY object NOTARY : Step
SIGNING object SIGNING : Step

Constructors

<init> Instigator(originalState: StateAndRef<S>, modification: T, progressTracker: ProgressTracker = tracker())

Properties

modification val modification: T
originalState val originalState: StateAndRef<S>
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.

Inherited Properties

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.

topic abstract 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.

Functions

call open fun call(): StateAndRef<S>

This is where you fill out your business logic.

Inherited Functions

receive fun <T : Any> receive(otherParty: Party, receiveType: Class<T>): UntrustworthyData<T>
fun <T : Any> receive(otherParty: Party): UntrustworthyData<T>
registerSession fun registerSession(receivedHandshake: HandshakeMessage): Unit

If a node receives a HandshakeMessage it needs to call this method on the initiated receipt protocol to enable communication between it and the sender protocol. Calling this method, and other initiation steps, are already handled by AbstractNodeService.addProtocolHandler.

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>, inheritParentSessions: Boolean = false): R

Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the ProtocolStateMachine and then calling the call method.

Companion Object Functions

tracker fun tracker(): ProgressTracker

Inheritors

Instigator class Instigator<T : ContractState> : Instigator<T, Party>