Package com.linecorp.armeria.common.stream

Class PathStreamMessageBuilder

java.lang.Object

com.linecorp.armeria.common.stream.PathStreamMessageBuilder

@UnstableApi
public final class PathStreamMessageBuilder
extends Object

A builder for creating a ByteStreamMessage that reads data from the Path and publishes using HttpData.

Method Summary

Modifier and Type	Method	Description
PathStreamMessageBuilder	alloc(ByteBufAllocator alloc)	Sets the specified ByteBufAllocator.
PathStreamMessageBuilder	bufferSize(int bufferSize)	Sets the buffer size used to create a buffer used to read data from the source.
ByteStreamMessage	build()	Returns a newly created ByteStreamMessage with the properties set so far.
PathStreamMessageBuilder	executor(ExecutorService executor)	Sets the specified ExecutorService that performs blocking IO read operations.

Methods inherited from class java.lang.Object

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

Method Details

alloc

public PathStreamMessageBuilder alloc(ByteBufAllocator alloc)

Sets the specified ByteBufAllocator. If unspecified, ByteBufAllocator.DEFAULT is used by default.

build

public ByteStreamMessage build()

Returns a newly created ByteStreamMessage with the properties set so far.

executor

public PathStreamMessageBuilder executor(ExecutorService executor)

Sets the specified ExecutorService that performs blocking IO read operations.

bufferSize

public PathStreamMessageBuilder bufferSize(int bufferSize)

Sets the buffer size used to create a buffer used to read data from the source. The newly created StreamMessage will emit HttpDatas chunked to size less than or equal to the buffer size. If unspecified, 8192 is used by default.

Throws:

IllegalArgumentException - if the bufferSize is non-positive.