Package com.linecorp.armeria.common.stream

Class StreamMessages

java.lang.Object

com.linecorp.armeria.common.stream.StreamMessages

@UnstableApi
public final class StreamMessages
extends Object

A utility class for StreamMessage.

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<Void>	writeTo(StreamMessage<? extends HttpData> publisher, Path destination, EventExecutor eventExecutor, ExecutorService blockingTaskExecutor, OpenOption... options)	Writes the specified StreamMessage to the given Path with OpenOptions.
static CompletableFuture<Void>	writeTo(StreamMessage<? extends HttpData> publisher, Path destination, OpenOption... options)	Writes the specified StreamMessage to the given Path with OpenOptions.

Methods inherited from class java.lang.Object

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

Method Details

writeTo

public static CompletableFuture<Void> writeTo(StreamMessage<? extends HttpData> publisher,
 Path destination,
 OpenOption... options)

Writes the specified StreamMessage to the given Path with OpenOptions. If the OpenOptions are not specified, they default to StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING and StandardOpenOption.WRITE.

Parameters:

publisher - the source of HttpData to be read from.

destination - the Path to write to.

options - the OpenOptions specifying how the file is opened.

Returns:

a CompletableFuture that completes successfully when the StreamMessage is fully written to the Path or exceptionally an error occurred while writing the StreamMessage.

writeTo

public static CompletableFuture<Void> writeTo(StreamMessage<? extends HttpData> publisher,
 Path destination,
 EventExecutor eventExecutor,
 ExecutorService blockingTaskExecutor,
 OpenOption... options)

Writes the specified StreamMessage to the given Path with OpenOptions. If the OpenOptions are not specified, they default to StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING and StandardOpenOption.WRITE.

Parameters:

publisher - the source of HttpData to be read from.

destination - the Path to write to.

eventExecutor - the EventExecutor to subscribe to the given publisher.

blockingTaskExecutor - the ExecutorService to which blocking tasks are submitted to handle file I/O events and write operations.

options - the OpenOptions specifying how the file is opened

Returns:

a CompletableFuture that completes successfully when the StreamMessage is fully written to the Path or exceptionally an error occurred while writing the StreamMessage.