solve/it.unibo.tuprolog.solve.channel/OutputChannel

OutputChannel

interface OutputChannel<T : Any> : Channel<T>

A Channel a it.unibo.tuprolog.solve.Solver writes T-typed elements to, e.g. backing Prolog's write/1, a solver's standard output/error, or warning reporting.

Build one via the companion's stdOut/stdErr/warn (platform defaults), or of (wrapping a consumer function).

Inheritors

AbstractOutputChannel

Types

Companion

object Companion

Properties

isClosed

abstract val isClosed: Boolean

Whether this channel has been closed.

streamTerm

abstract val streamTerm: Struct

The Prolog $stream(Direction, Id)-like Struct term identifying this channel, e.g. for current_output/1.

Functions

addListener

abstract fun addListener(listener: Listener<T?>)

Registers listener to be invoked with every element subsequently transiting this channel.

clearListeners

abstract fun clearListeners()

Unregisters every currently-registered Listener.

abstract fun close()

Closes this channel; further reads/writes on it are expected to fail.

flush

abstract fun flush()

Flushes any buffered output on this channel.

removeListener

abstract fun removeListener(listener: Listener<T?>)

Unregisters listener, previously added via addListener.

use

open fun <R> use(function: OutputChannel<T>.() -> R): R

Runs function against this channel, closeing it once function returns normally (not on exceptions).

write

abstract fun write(value: T)

Writes value to this channel, notifying every registered Listener.