simulator/com.group7.channels

Package-level declarations

Types

ChannelNotReadyException

class ChannelNotReadyException(channel: PullInputChannel<*>) : Exception

Exception thrown when attempting to receive from a pull channel that is not ready.

ChannelType

sealed interface ChannelType<SelfT : ChannelType<SelfT>>

Marker type for distinguishing between push and pull channel semantics.

ClosedChannelException

class ClosedChannelException(channel: PushOutputChannel<*>) : Exception

Exception thrown when attempting to send data through a push channel that is closed.

ConnectableInputChannel

sealed interface ConnectableInputChannel<ItemT, ChannelT : ChannelType<ChannelT>> : InputChannel<ItemT, ChannelT>

Input channel that can be manually connected to an output channel.

ConnectableOutputChannel

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

Output channel that can be manually connected to an input channel.

ConnectablePullInputChannel

sealed interface ConnectablePullInputChannel<T> : InputChannel<T, ChannelType.Pull> , ConnectableInputChannel<T, ChannelType.Pull>

A pull input channel that can be manually connected to an output channel.

ConnectablePullOutputChannel

sealed interface ConnectablePullOutputChannel<T> : OutputChannel<T, ChannelType.Pull> , ConnectableOutputChannel<T, ChannelType.Pull>

A pull output channel that can be manually connected to an input channel.

ConnectablePushInputChannel

sealed interface ConnectablePushInputChannel<T> : InputChannel<T, ChannelType.Push> , ConnectableInputChannel<T, ChannelType.Push>

A push input channel that can be manually connected to an output channel.

ConnectablePushOutputChannel

sealed interface ConnectablePushOutputChannel<T> : OutputChannel<T, ChannelType.Push> , ConnectableOutputChannel<T, ChannelType.Push>

A push output channel that can be manually connected to an input channel.

InputChannel

sealed interface InputChannel<out ItemT, ChannelT : ChannelType<ChannelT>>

Base interface for the input side of a communication channel.

OutputChannel

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

Base interface for the output side of a communication channel.

PullInputChannel

typealias PullInputChannel<T> = InputChannel<T, ChannelType.Pull>

Type alias for a pull input channel.

PullOutputChannel

typealias PullOutputChannel<T> = OutputChannel<T, ChannelType.Pull>

Type alias for a pull output channel.

PushInputChannel

typealias PushInputChannel<T> = InputChannel<T, ChannelType.Push>

Type alias for a push input channel.

PushOutputChannel

typealias PushOutputChannel<T> = OutputChannel<T, ChannelType.Push>

Type alias for a push output channel.

Functions

context(_: Simulator)
fun PushInputChannel<*>.close()

Closes this push input channel to prevent further data transfers.

isOpen

fun PushOutputChannel<*>.isOpen(): Boolean

Checks if this push output channel is open.

isPull

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

Checks if this input channel uses pull semantics.

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

Checks if this output channel uses pull semantics.

isPush

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

Checks if this input channel uses push semantics.

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

Checks if this output channel uses push semantics.

isReady

fun PullInputChannel<*>.isReady(): Boolean

Checks if this pull input channel is ready to receive data.

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.

newConnectableInputChannel

fun <ItemT, ChannelT : ChannelType<ChannelT>> newConnectableInputChannel(type: ChannelT): ConnectableInputChannel<ItemT, ChannelT>

Factory function to create a connectable input channel of the specified type.

newConnectableOutputChannel

fun <ItemT, ChannelT : ChannelType<ChannelT>> newConnectableOutputChannel(type: ChannelT): ConnectableOutputChannel<ItemT, ChannelT>

Factory function to create a connectable output channel of the specified type.

newConnectablePullInputChannel

fun <T> newConnectablePullInputChannel(): ConnectablePullInputChannel<T>

Creates a new connectable pull input channel.

newConnectablePullOutputChannel

fun <T> newConnectablePullOutputChannel(): ConnectablePullOutputChannel<T>

Creates a new connectable pull output channel.

newConnectablePushInputChannel

fun <T> newConnectablePushInputChannel(): ConnectablePushInputChannel<T>

Creates a new connectable push input channel.

newConnectablePushOutputChannel

fun <T> newConnectablePushOutputChannel(): ConnectablePushOutputChannel<T>

Creates a new connectable push output channel.

newPullChannel

fun <T> newPullChannel(): Pair<PullOutputChannel<T>, PullInputChannel<T>>

Creates a new pull channel pair.

newPullChannels

fun <T> newPullChannels(n: Int): Pair<List<PullOutputChannel<T>>, List<PullInputChannel<T>>>

Creates multiple pull channel pairs.

newPushChannel

fun <T> newPushChannel(): Pair<PushOutputChannel<T>, PushInputChannel<T>>

Creates a new push channel pair.

newPushChannels

fun <T> newPushChannels(n: Int): Pair<List<PushOutputChannel<T>>, List<PushInputChannel<T>>>

Creates multiple push channel pairs.

onPull

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

Sets the pull callback that generates data on demand.

onReceive

fun <T> PushInputChannel<T>.onReceive(callback: context(Simulator) (T) -> Unit)

Sets the callback that will be invoked when data is received on this channel.

open

context(_: Simulator)
fun PushInputChannel<*>.open()

Opens this push input channel to allow data transfers.

receive

context(_: Simulator)
fun <T> PullInputChannel<T>.receive(): T

Receives data from this pull input channel.

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.

whenNotReady

fun PullInputChannel<*>.whenNotReady(callback: context(Simulator) () -> Unit)

Registers a callback to be invoked when this channel becomes not ready.

whenOpened

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

Registers a callback to be invoked when this channel opens.

whenReady

fun PullInputChannel<*>.whenReady(callback: context(Simulator) () -> Unit)

Registers a callback to be invoked when this channel becomes ready.