io.servicetalk.http.api

Interface HttpPayloadWriter<T>

Type Parameters:

T - the type of objects to write

All Superinterfaces:

AutoCloseable, Closeable, Flushable, PayloadWriter<T>

public interface HttpPayloadWriter<T>
extends PayloadWriter<T>

An interface which mimics behavior like OutputStream, but allows for writing of objects of type T and provides access to the HTTP trailers.

Method Summary

Modifier and Type	Method and Description
default HttpPayloadWriter<T>	addTrailer(CharSequence name, CharSequence value) Adds a new trailer with the specified name and value.
default HttpPayloadWriter<T>	addTrailers(HttpHeaders trailers) Adds all trailer names and values of trailer object.
default HttpPayloadWriter<T>	setTrailer(CharSequence name, CharSequence value) Sets a trailer with the specified name and value.
default HttpPayloadWriter<T>	setTrailers(HttpHeaders trailers) Clears the current trailer entries and copies all trailer entries of the specified trailers object.
HttpHeaders	trailers() Gets the trailers.

Methods inherited from interface PayloadWriter

close, write

Methods inherited from interface Closeable

close

Methods inherited from interface Flushable

flush

Method Detail

addTrailer

default HttpPayloadWriter<T> addTrailer(CharSequence name,
                                        CharSequence value)

Adds a new trailer with the specified name and value.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

addTrailers

default HttpPayloadWriter<T> addTrailers(HttpHeaders trailers)

Adds all trailer names and values of trailer object.

Parameters:

trailers - the trailers to add.

Returns:

this.

setTrailer

default HttpPayloadWriter<T> setTrailer(CharSequence name,
                                        CharSequence value)

Sets a trailer with the specified name and value. Any existing trailers with the same name are overwritten.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

setTrailers

default HttpPayloadWriter<T> setTrailers(HttpHeaders trailers)

Clears the current trailer entries and copies all trailer entries of the specified trailers object.

Parameters:

trailers - the trailers object which contains new values.

Returns:

this.

trailers

HttpHeaders trailers()

Gets the trailers.

Returns:

the trailers.