org.springframework.http

Interface ZeroCopyHttpOutputMessage

All Superinterfaces:

HttpMessage, ReactiveHttpOutputMessage

All Known Implementing Classes:

ReactorClientHttpRequest, ReactorServerHttpResponse, UndertowServerHttpResponse

public interface ZeroCopyHttpOutputMessage
extends ReactiveHttpOutputMessage

Sub-interface of ReactiveOutputMessage that has support for "zero-copy" file transfers.

Since:

5.0

Author:

Arjen Poutsma, Juergen Hoeller

See Also:

Zero-copy

Method Summary

Modifier and Type	Method and Description
default <any>	writeWith(java.io.File file, long position, long count) Use the given File to write the body of the message to the underlying HTTP layer.
<any>	writeWith(java.nio.file.Path file, long position, long count) Use the given Path to write the body of the message to the underlying HTTP layer.

Methods inherited from interface org.springframework.http.ReactiveHttpOutputMessage

beforeCommit, bufferFactory, isCommitted, setComplete, writeAndFlushWith, writeWith

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Method Detail

writeWith

default <any> writeWith(java.io.File file,
                        long position,
                        long count)

Use the given File to write the body of the message to the underlying HTTP layer.

Parameters:

file - the file to transfer

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

a publisher that indicates completion or error.

writeWith

<any> writeWith(java.nio.file.Path file,
                long position,
                long count)

Use the given Path to write the body of the message to the underlying HTTP layer.

Parameters:

file - the file to transfer

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

a publisher that indicates completion or error.

Since:

5.1