Polishing
This commit is contained in:
parent
2a77665be7
commit
834d22f866
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright 2002-2021 the original author or authors.
|
||||
* Copyright 2002-2023 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
@ -43,12 +43,11 @@ public interface ExchangeFunction {
|
|||
|
||||
/**
|
||||
* Exchange the given request for a {@link ClientResponse} promise.
|
||||
*
|
||||
* <p><strong>Note:</strong> When calling this method from an
|
||||
* {@link ExchangeFilterFunction} that handles the response in some way,
|
||||
* extra care must be taken to always consume its content or otherwise
|
||||
* propagate it downstream for further handling, for example by the
|
||||
* {@link WebClient}. Please, see the reference documentation for more
|
||||
* {@link WebClient}. Please see the reference documentation for more
|
||||
* details on this.
|
||||
* @param request the request to exchange
|
||||
* @return the delayed response
|
||||
|
|
|
@ -22,11 +22,11 @@ import kotlinx.coroutines.reactor.mono
|
|||
import reactor.core.publisher.Mono
|
||||
|
||||
/**
|
||||
* Kotlin-specific implementation of the [ExchangeFilterFunction] interface that allows for
|
||||
* using coroutines.
|
||||
* Kotlin-specific implementation of the [ExchangeFilterFunction] interface
|
||||
* that allows for using coroutines.
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
* @since 6.1.0
|
||||
* @since 6.1
|
||||
*/
|
||||
abstract class CoExchangeFilterFunction : ExchangeFilterFunction {
|
||||
|
||||
|
@ -48,8 +48,8 @@ abstract class CoExchangeFilterFunction : ExchangeFilterFunction {
|
|||
* proceed with the exchange, or not invoked to short-circuit the chain.
|
||||
*
|
||||
* **Note:** When a filter handles the response after the
|
||||
* call to [CoExchangeFunction.exchange], extra care must be taken
|
||||
* to always consume its content or otherwise propagate it downstream for
|
||||
* call to [CoExchangeFunction.exchange], extra care must be taken to
|
||||
* always consume its content or otherwise propagate it downstream for
|
||||
* further handling, for example by the [WebClient]. Please see the
|
||||
* reference documentation for more details on this.
|
||||
*
|
||||
|
@ -60,11 +60,12 @@ abstract class CoExchangeFilterFunction : ExchangeFilterFunction {
|
|||
protected abstract suspend fun filter(request: ClientRequest, next: CoExchangeFunction): ClientResponse
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Kotlin-specific adaption of [ExchangeFunction] that allows for coroutines.
|
||||
*
|
||||
* @author Sebastien Deleuze
|
||||
* @since 6.1.0
|
||||
* @since 6.1
|
||||
*/
|
||||
interface CoExchangeFunction {
|
||||
|
||||
|
@ -75,7 +76,7 @@ interface CoExchangeFunction {
|
|||
* [CoExchangeFilterFunction] that handles the response in some way,
|
||||
* extra care must be taken to always consume its content or otherwise
|
||||
* propagate it downstream for further handling, for example by the
|
||||
* [WebClient]. Please, see the reference documentation for more
|
||||
* [WebClient]. Please see the reference documentation for more
|
||||
* details on this.
|
||||
*
|
||||
* @param request the request to exchange
|
||||
|
|
Loading…
Reference in New Issue