spi/me.ahoo.wow.spi.wait/WaitContext

WaitContext

class WaitContext @InternalWowApi constructor(val waitId: String, val origin: Origin, val remaining: List<Hop>, val deadline: Long)

What travels with a command's messages and its log entry while its caller waits beyond COMMITTED: transport metadata, never a fact, invisible to domain code.

waitId identifies the wait on its origin.
remaining are the hops not reached yet. On a log entry they start after COMMITTED, so the first one, a HANDLED hop, names the subscription that signals once it has handled the entry.
deadline is when the wait gives up, in epoch milliseconds; past it no one signals.

Fields may be added: construct one with of; the constructor is internal to Wow.

Constructors

WaitContext

@InternalWowApi

constructor(waitId: String, origin: Origin, remaining: List<Hop>, deadline: Long)

Types

Companion

object Companion

Properties

deadline

val deadline: Long

nextHandled

val nextHandled: Hop?

The HANDLED hop an entry carrying this context waits for next, if any.

origin

val origin: Origin

remaining

val remaining: List<Hop>

waitId

val waitId: String

Functions

afterCommitted

fun afterCommitted(): WaitContext

This context once its command is committed: without the leading ACCEPTED and COMMITTED hops.

copyWith

@InternalWowApi

fun copyWith(waitId: String = this.waitId, origin: Origin = this.origin, remaining: List<Hop> = this.remaining, deadline: Long = this.deadline): WaitContext

This WaitContext with the given fields replaced: Wow's own copy, left out of the ABI.

derived

fun derived(): WaitContext?

This context for the commands a saga derives at the hop remaining starts with: the hops after it, or null when there are none (the chain ends at the saga).

equals

open operator override fun equals(other: Any?): Boolean

expiredAt

fun expiredAt(now: Long): Boolean

Whether the wait is over at now.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

toWire

@InternalWowApi

fun WaitContext.toWire(): WaitWire

This context on the wire, as Wow-Call and the cluster channel carry it.