Class ChannelSink

Inheritance

object

ChannelSink

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Streams.Dsl

Assembly: Akka.Streams.dll

Syntax

public static class ChannelSink

Methods

AsReader<T>(int, bool, BoundedChannelFullMode)

Creates a sink that upon materialization, returns a ChannelReader<T> connected with this materialized graph. It can then be used to consume events incoming from the graph. It will also be completed once upstream completes.

Declaration

public static Sink<T, ChannelReader<T>> AsReader<T>(int bufferSize, bool singleReader = false, BoundedChannelFullMode fullMode = BoundedChannelFullMode.Wait)

Parameters

Type	Name	Description
int	bufferSize
bool	singleReader
BoundedChannelFullMode	fullMode

Returns

Type	Description
Sink<T, ChannelReader<T>>

Type Parameters

Name	Description
T

FromWriter<T>(ChannelWriter<T>, bool)

Creates a Sink, that will emit incoming events directly into provider ChannelWriter<T>. It will handle problems such as backpressure and writer. When isOwner is set to true, it will also take responsibility to complete given writer.

Declaration

public static Sink<T, NotUsed> FromWriter<T>(ChannelWriter<T> writer, bool isOwner)

Parameters

Type	Name	Description
ChannelWriter<T>	writer	A ChannelWriter<T> to pass events emitted from materialized graph to.
bool	isOwner	Determines materialized graph should be responsible for completing given writer.

Returns

Type	Description
Sink<T, NotUsed>

Type Parameters

Name	Description
T	Type of events passed to writer.