simulator/com.group7.channels/OutputChannel

OutputChannel

sealed interface OutputChannel<in ItemT, ChannelT : ChannelType<ChannelT>>

Base interface for the output side of a communication channel.

The output side connects the upstream Node to the downstream InputChannel.

Parameters

ItemT

the type of items transmitted through this channel

ChannelT

the channel type (Push or Pull)

Inheritors

ConnectableOutputChannel

ConnectablePullOutputChannel

ConnectablePushOutputChannel

Properties

downstream

abstract val downstream: InputChannel<*, ChannelT>

The input channel connected downstream.

transmissionCount

abstract val transmissionCount: Int

Total number of data transmissions through this channel.

upstreamNode

abstract val upstreamNode: Node

The Node that sends data through this output channel.

Functions

isOpen

fun PushOutputChannel<*>.isOpen(): Boolean

Checks if this push output channel is open.

isPull

fun <T> OutputChannel<T, *>.isPull(): Boolean

Checks if this output channel uses pull semantics.

isPush

fun <T> OutputChannel<T, *>.isPush(): Boolean

Checks if this output channel uses push semantics.

markNotReady

context(_: Simulator)
fun PullOutputChannel<*>.markNotReady()

Marks this pull output channel as no longer ready to receive requests.

markReady

context(_: Simulator)
fun PullOutputChannel<*>.markReady()

Marks this pull output channel as ready to receive requests.

onPull

fun <T> PullOutputChannel<T>.onPull(callback: context(Simulator) () -> T)

Sets the pull callback that generates data on demand.

send

context(_: Simulator)
fun <T> PushOutputChannel<T>.send(data: T)

Sends data through this push output channel.

whenClosed

fun PushOutputChannel<*>.whenClosed(callback: context(Simulator) () -> Unit)

Registers a callback to be invoked when this channel closes.

whenOpened

fun PushOutputChannel<*>.whenOpened(callback: context(Simulator) () -> Unit)

Registers a callback to be invoked when this channel opens.