Channel

zio.http.Channel
trait Channel[-A]

An immutable and type-safe representation of one or more netty channels. A represents the type of messages that can be written on the channel.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ChannelNetty[A]

Members list

Concise view

Value members

Abstract methods

def autoRead(flag: Boolean)(implicit trace: Trace): UIO[Unit]

When set to true (default) it will automatically read messages from the channel. When set to false, the channel will not read messages until read is called.

When set to true (default) it will automatically read messages from the channel. When set to false, the channel will not read messages until read is called.

Attributes

def awaitClose(implicit trace: Trace): UIO[Unit]

Provides a way to wait for the channel to be closed.

Provides a way to wait for the channel to be closed.

Attributes

def close(await: Boolean)(implicit trace: Trace): Task[Unit]

Closes the channel. Pass true to await to wait for the channel to be closed.

Closes the channel. Pass true to await to wait for the channel to be closed.

Attributes

def contramap[A1](f: A1 => A): Channel[A1]

Creates a new channel that can write a different type of message by using a transformation function.

Creates a new channel that can write a different type of message by using a transformation function.

Attributes

def flush(implicit trace: Trace): Task[Unit]

Flushes the pending write operations on the channel.

Flushes the pending write operations on the channel.

Attributes

def id(implicit trace: Trace): String

Returns the globally unique identifier of this channel.

Returns the globally unique identifier of this channel.

Attributes

def isAutoRead(implicit trace: Trace): UIO[Boolean]

Returns true if auto-read is set to true.

Returns true if auto-read is set to true.

Attributes

def read(implicit trace: Trace): UIO[Unit]

Schedules a read operation on the channel. This is not necessary if auto-read is enabled.

Schedules a read operation on the channel. This is not necessary if auto-read is enabled.

Attributes

def write(msg: A, await: Boolean)(implicit trace: Trace): Task[Unit]

Schedules a write operation on the channel. The actual write only happens after calling flush. Pass true to await the completion of the write operation.

Schedules a write operation on the channel. The actual write only happens after calling flush. Pass true to await the completion of the write operation.

Attributes

def writeAndFlush(msg: A, await: Boolean)(implicit trace: Trace): Task[Unit]

Writes and flushes the message on the channel. Pass true to await the completion of the write operation.

Writes and flushes the message on the channel. Pass true to await the completion of the write operation.

Attributes