Package com.linecorp.armeria.server.annotation

Class ServerSentEventResponseConverterFunction

java.lang.Object

com.linecorp.armeria.server.annotation.ServerSentEventResponseConverterFunction

All Implemented Interfaces:

ResponseConverterFunction

public class ServerSentEventResponseConverterFunction
extends Object
implements ResponseConverterFunction

A response converter implementation which creates an HttpResponse with content-type: text/event-stream. The objects published from a Publisher or Stream would be converted into Server-Sent Events if a ProducesEventStream annotation is specified on an annotated service method.

Constructor Summary

Constructors

Constructor	Description
ServerSentEventResponseConverterFunction()

Method Summary

Modifier and Type	Method	Description
HttpResponse	convertResponse(ServiceRequestContext ctx, HttpHeaders headers, Object result, HttpHeaders trailingHeaders)	Returns HttpResponse instance corresponds to the given result.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSentEventResponseConverterFunction

public ServerSentEventResponseConverterFunction()

Method Detail

convertResponse

public HttpResponse convertResponse(ServiceRequestContext ctx,
                                    HttpHeaders headers,
                                    @Nullable
                                    Object result,
                                    HttpHeaders trailingHeaders)
                             throws Exception

Description copied from interface: ResponseConverterFunction

Returns HttpResponse instance corresponds to the given result. Calls ResponseConverterFunction.fallthrough() or throws a FallthroughException if this converter cannot convert the result to the HttpResponse.

Specified by:

convertResponse in interface ResponseConverterFunction

headers - The HTTP headers that you might want to use to create the HttpResponse. The status of headers is HttpStatus.OK by default or HttpStatus.NO_CONTENT if the annotated method returns void, unless you specify it with StatusCode on the method. The headers also will include a MediaType if ServiceRequestContext.negotiatedResponseMediaType() returns it. If the method returns HttpResult, this headers is the same headers from HttpResult.headers() The headers could be immutable, so please call HttpHeaders.toMutable(). Please note that the additional headers set by ServiceRequestContext.addAdditionalResponseHeader(AsciiString, String) and AdditionalHeader are not included in this headers.

result - The result of the service method.

trailingHeaders - The HTTP trailers that you might want to use to create the HttpResponse. If the annotated method returns HttpResult, this trailers is the same trailers from HttpResult.trailingHeaders(). The trailers could be immutable, so please call HttpHeaders.toMutable(). Please note that the additional trailers set by ServiceRequestContext.addAdditionalResponseTrailer(AsciiString, String) and AdditionalTrailer are not included in this trailers.

Throws:

Exception