Package com.azure.core.http.rest

Class StreamResponse

java.lang.Object

com.azure.core.http.rest.SimpleResponse<Flux<ByteBuffer>>

com.azure.core.http.rest.StreamResponse

All Implemented Interfaces:

Response<Flux<ByteBuffer>>, Closeable, AutoCloseable

public final class StreamResponse
extends SimpleResponse<Flux<ByteBuffer>>
implements Closeable

This class represents a REST response with a streaming content. It encapsulates the HTTP request that resulted in the response, the status code of the HTTP response, the headers of the HTTP response, and the content of the HTTP response as a stream of byte buffers.

It also provides methods to write the content of the HTTP response to a AsynchronousByteChannel or a WritableByteChannel, and to dispose the connection associated with the response.

Constructor Summary

Constructors

Constructor	Description
StreamResponse(HttpRequest request, int statusCode, HttpHeaders headers, Flux<ByteBuffer> value)	Deprecated. Use StreamResponse(HttpResponse)
StreamResponse(HttpResponse response)	Creates a StreamResponse.

Method Summary

Modifier and Type	Method	Description
void	close()	Disposes the connection associated with this StreamResponse.
Flux<ByteBuffer>	getValue()	The content of the HTTP response as a stream of byte buffers.
void	writeValueTo(WritableByteChannel channel)	Transfers content bytes to the WritableByteChannel.
Mono<Void>	writeValueToAsync(AsynchronousByteChannel channel)	Transfers content bytes to the AsynchronousByteChannel.

Methods inherited from class com.azure.core.http.rest.SimpleResponse

getHeaders, getRequest, getStatusCode

Methods inherited from class java.lang.Object

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

Constructor Details

StreamResponse

@Deprecated
public StreamResponse(HttpRequest request,
 int statusCode,
 HttpHeaders headers,
 Flux<ByteBuffer> value)

Deprecated.

Use StreamResponse(HttpResponse)

Creates a StreamResponse.

Parameters:

request - The request which resulted in this response.

statusCode - The status code of the HTTP response.

headers - The headers of the HTTP response.

value - The content of the HTTP response.

StreamResponse

public StreamResponse(HttpResponse response)

Creates a StreamResponse.

Parameters:

response - The HTTP response.

Method Details

getValue

public Flux<ByteBuffer> getValue()

The content of the HTTP response as a stream of byte buffers.

Specified by:

getValue in interface Response<Flux<ByteBuffer>>

Overrides:

getValue in class SimpleResponse<Flux<ByteBuffer>>

Returns:

The content of the HTTP response as a stream of byte buffers.

writeValueToAsync

public Mono<Void> writeValueToAsync(AsynchronousByteChannel channel)

Transfers content bytes to the AsynchronousByteChannel.

Parameters:

channel - The destination AsynchronousByteChannel.

Returns:

A Mono that completes when transfer is completed.

writeValueTo

public void writeValueTo(WritableByteChannel channel)

Transfers content bytes to the WritableByteChannel.

Parameters:

channel - The destination WritableByteChannel.

Throws:

UncheckedIOException - When I/O operation fails.

close

public void close()

Disposes the connection associated with this StreamResponse.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable