io.servicetalk.http.api

Interface HttpStreamingSerializer<T>

Type Parameters:

T - The type of objects to serialize.

All Known Subinterfaces:

HttpStreamingSerializerDeserializer<T>

public interface HttpStreamingSerializer<T>

HTTP request/response serialization for streaming payload bodies.

Method Summary

Modifier and Type	Method and Description
default BlockingIterable<Buffer>	serialize(HttpHeaders headers, BlockingIterable<T> value, BufferAllocator allocator) Serialize an BlockingIterable of type T into an BlockingIterable of type Buffer.
HttpPayloadWriter<T>	serialize(HttpHeaders headers, HttpPayloadWriter<Buffer> payloadWriter, BufferAllocator allocator) Returns an HttpPayloadWriter of type T which serializes each written object into a Buffer.
Publisher<Buffer>	serialize(HttpHeaders headers, Publisher<T> value, BufferAllocator allocator) Serialize a Publisher of type T into a Publisher of type Buffer.

Method Detail

serialize

Publisher<Buffer> serialize(HttpHeaders headers,
                            Publisher<T> value,
                            BufferAllocator allocator)

Serialize a Publisher of type T into a Publisher of type Buffer. If necessary the HttpHeaders should be updated to indicate the content-type.

Parameters:

headers - The HttpHeaders associated with the serialization operation.

value - The objects to serialize.

allocator - The BufferAllocator used to create the resulting Buffers.

Returns:

The result of the serialization operation.

serialize

default BlockingIterable<Buffer> serialize(HttpHeaders headers,
                                           BlockingIterable<T> value,
                                           BufferAllocator allocator)

Serialize an BlockingIterable of type T into an BlockingIterable of type Buffer. If necessary the HttpHeaders should be updated to indicate the content-type.

Parameters:

headers - The HttpHeaders associated with the serialization operation.

value - The objects to serialize.

allocator - The BufferAllocator used to create the resulting Buffers.

Returns:

The result of the serialization operation.

serialize

HttpPayloadWriter<T> serialize(HttpHeaders headers,
                               HttpPayloadWriter<Buffer> payloadWriter,
                               BufferAllocator allocator)

Returns an HttpPayloadWriter of type T which serializes each written object into a Buffer. If necessary the HttpHeaders should be updated to indicate the content-type.

Parameters:

headers - The HttpHeaders associated with the serialization operation.

payloadWriter - The HttpPayloadWriter which writes serialized Buffers.

allocator - The BufferAllocator used to create the resulting Buffers.

Returns:

The HttpPayloadWriter of type T with embedded serialization into a Buffer.