Package io.servicetalk.concurrent.api.internal

Class ConnectablePayloadWriter<T>

java.lang.Object

io.servicetalk.concurrent.api.internal.ConnectablePayloadWriter<T>

Type Parameters:

T - The type of data for the PayloadWriter.

All Implemented Interfaces:

PayloadWriter<T>, Closeable, Flushable, AutoCloseable

public final class ConnectablePayloadWriter<T>
extends Object
implements PayloadWriter<T>

A PayloadWriter that can be connected to a sink such that any data written on the PayloadWriter is eventually emitted to the connected Publisher PublisherSource.Subscriber.

Constructor Summary

Constructors

Constructor	Description
ConnectablePayloadWriter()

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(Throwable cause)	This method shares the same characteristics as Closeable.close() but propagates cause to downstream consumer instead of propagating "successful" completion.
Publisher<T>	connect()	Connects this PayloadWriter to the returned Publisher such that any data written to this PayloadWriter is eventually delivered to a PublisherSource.Subscriber of the returned Publisher.
void	flush()
void	write(T t)	Write an object of type PayloadWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConnectablePayloadWriter

public ConnectablePayloadWriter()

Method Details

write

public void write(T t)
           throws IOException

Description copied from interface: PayloadWriter

Write an object of type PayloadWriter.

Specified by:

write in interface PayloadWriter<T>

Parameters:

t - the object to write.

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if this has been closed.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

close

public void close(Throwable cause)
           throws IOException

Description copied from interface: PayloadWriter

This method shares the same characteristics as Closeable.close() but propagates cause to downstream consumer instead of propagating "successful" completion. Here are notable characteristics shared with Closeable.close():

• Resources are reclaimed
• This method is idempotent
• Subsequent calls to PayloadWriter.write(Object) are expected to fail
• Before any exception is thrown, all resources must be reclaimed and cause propagated

Specified by:

close in interface PayloadWriter<T>

Parameters:

cause - Indicate the close is a result of a failure.

Throws:

IOException - if an input/output error occurs.

connect

public Publisher<T> connect()

Connects this PayloadWriter to the returned Publisher such that any data written to this PayloadWriter is eventually delivered to a PublisherSource.Subscriber of the returned Publisher.

Returns:

Publisher that will emit all data written to this PayloadWriter to its PublisherSource.Subscriber. Only a single active PublisherSource.Subscriber is allowed for this Publisher.