Package com.linecorp.armeria.server.annotation

Class ServerSentEventResponseConverterFunction

java.lang.Object

com.linecorp.armeria.server.annotation.ServerSentEventResponseConverterFunction

All Implemented Interfaces:

ResponseConverterFunction

public final 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, ResponseHeaders headers, @Nullable Object result, HttpHeaders trailers)	Returns HttpResponse instance corresponds to the given result.
Boolean	isResponseStreaming(Type returnType, @Nullable MediaType contentType)	Returns whether an HttpResponse of an annotated service should be streamed.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerSentEventResponseConverterFunction

public ServerSentEventResponseConverterFunction()

Method Details

isResponseStreaming

public Boolean isResponseStreaming(Type returnType,
 @Nullable
 @Nullable MediaType contentType)

Description copied from interface: ResponseConverterFunction

Returns whether an HttpResponse of an annotated service should be streamed. null if this converter cannot convert the responseType to an HttpResponse. true can be returned if the response is a streaming type, or the ResponseConverterFunction has not been optimized for the responseType through overriding this method for backward compatibility.

This method is used as a performance optimization hint. If the returnType and produceType are not a streaming response, it is recommended to return false for the better performance.

Note that you should never return false for a streaming response. The non-streaming response is aggregated before being sent.

Specified by:

isResponseStreaming in interface ResponseConverterFunction

Parameters:

returnType - the return type of the annotated service.

contentType - the negotiated producible media type of the annotated service. null if the media type negotiation is not used for the service.

convertResponse

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

Description copied from interface: ResponseConverterFunction

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

Specified by:

convertResponse in interface ResponseConverterFunction

Parameters:

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() Please note that the additional headers set by ServiceRequestContext.mutateAdditionalResponseHeaders(Consumer) and AdditionalHeader are not included in this headers.

result - The result of the service method.

trailers - 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.trailers(). Please note that the additional trailers set by ServiceRequestContext.mutateAdditionalResponseTrailers(Consumer) and AdditionalTrailer are not included in this trailers.

Throws:

Exception