spring-framework / org.springframework.web.servlet.mvc.method.annotation / StreamingResponseBody

StreamingResponseBody

@FunctionalInterface interface StreamingResponseBody

A controller method return value type for asynchronous request processing where the application can write directly to the response OutputStream without holding up the Servlet container thread.

Note: when using this option it is highly recommended to configure explicitly the TaskExecutor used in Spring MVC for executing asynchronous requests. Both the MVC Java config and the MVC namespaces provide options to configure asynchronous handling. If not using those, an application can set the taskExecutor property of org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.

Author
Rossen Stoyanchev

Since
4.2

Functions

writeTo

abstract fun writeTo(outputStream: OutputStream): Unit

A callback for writing to the response body.