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) Note: modifying trailers after the payload writer is closed is not allowed.
default HttpPayloadWriter<T>	addTrailers(HttpHeaders trailers) Note: modifying trailers after the payload writer is closed is not allowed.
default HttpPayloadWriter<T>	setTrailer(CharSequence name, CharSequence value) Note: modifying trailers after the payload writer is closed is not allowed.
default HttpPayloadWriter<T>	setTrailers(HttpHeaders trailers) Note: modifying trailers after the payload writer is closed is not allowed.
HttpHeaders	trailers() Note: modifying trailers after the payload writer is closed is not allowed.

Methods inherited from interface PayloadWriter

close, write

Methods inherited from interface Closeable

close

Methods inherited from interface Flushable

flush

Method Detail

trailers

HttpHeaders trailers()

Note: modifying trailers after the payload writer is closed is not allowed.

Returns:

the trailers.

addTrailer

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

Note: modifying trailers after the payload writer is closed is not allowed.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

addTrailers

default HttpPayloadWriter<T> addTrailers(HttpHeaders trailers)

Note: modifying trailers after the payload writer is closed is not allowed.

Parameters:

trailers - the trailers to add.

Returns:

this.

setTrailer

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

Note: modifying trailers after the payload writer is closed is not allowed.

Parameters:

name - the name of the trailer.

value - the value of the trailer.

Returns:

this.

setTrailers

default HttpPayloadWriter<T> setTrailers(HttpHeaders trailers)

Note: modifying trailers after the payload writer is closed is not allowed.

Parameters:

trailers - the trailers object which contains new values.

Returns:

this.