protocols / AbstractStateReplacementProtocol / Acceptor

Acceptor

abstract class Acceptor<T> : ProtocolLogic<Unit>


Types

APPROVING object APPROVING : Step
REJECTING object REJECTING : Step
VERIFYING object VERIFYING : Step

Constructors

<init> Acceptor(otherSide: Party, sessionIdForSend: Long, sessionIdForReceive: Long, progressTracker: ProgressTracker = tracker())

Properties

TOPIC_CHANGE abstract val TOPIC_CHANGE: String
TOPIC_INITIATE abstract val TOPIC_INITIATE: String
otherSide val otherSide: Party
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.

sessionIdForReceive val sessionIdForReceive: Long
sessionIdForSend val sessionIdForSend: Long

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.

Functions

call open fun call(): Unit

This is where you fill out your business logic.

Inherited Functions

receive fun <T : Any> receive(topic: String, sessionIDForReceive: Long, clazz: Class<T>): UntrustworthyData<T>
fun <T : Any> receive(topic: String, sessionIDForReceive: Long): UntrustworthyData<T>
send fun send(topic: String, destination: Party, sessionID: Long, payload: Any): Unit
sendAndReceive fun <T : Any> sendAndReceive(topic: String, 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.

Companion Object Functions

tracker fun tracker(): ProgressTracker

Inheritors

Acceptor class Acceptor : Acceptor<Party>