Skip to content

Commit

Permalink
Improve the documentation and discoverability of CoWebFilter
Browse files Browse the repository at this point in the history
Closes gh-31877
  • Loading branch information
sdeleuze committed Jan 3, 2024
1 parent 05ebca8 commit 207b9a1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Spring Framework provides support for Coroutines on the following scope:
* Suspending function support in Spring MVC and WebFlux annotated `@Controller`
* Extensions for WebFlux {spring-framework-api-kdoc}/spring-webflux/org.springframework.web.reactive.function.client/index.html[client] and {spring-framework-api-kdoc}/spring-webflux/org.springframework.web.reactive.function.server/index.html[server] functional API.
* WebFlux.fn {spring-framework-api-kdoc}/spring-webflux/org.springframework.web.reactive.function.server/co-router.html[coRouter { }] DSL
* WebFlux {spring-framework-api-kdoc}/spring-web/org.springframework.web.server/-co-web-filter/index.html[`CoWebFilter`]
* Suspending function and `Flow` support in RSocket `@MessageMapping` annotated methods
* Extensions for {spring-framework-api-kdoc}/spring-messaging/org.springframework.messaging.rsocket/index.html[`RSocketRequester`]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
* be used to implement cross-cutting, application-agnostic requirements such
* as security, timeouts, and others.
*
* <p>Consider using {@code org.springframework.web.server.CoWebFilter} with
* Kotlin Coroutines.
*
* @author Rossen Stoyanchev
* @since 5.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import kotlin.coroutines.CoroutineContext

/**
* Kotlin-specific implementation of the [WebFilter] interface that allows for
* using coroutines.
* using coroutines, including [kotlin.coroutines.CoroutineContext] propagation.
*
* @author Arjen Poutsma
* @author Sebastien Deleuze
Expand Down

0 comments on commit 207b9a1

Please sign in to comment.