root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Improve PartEvent documentation 

Add note about the necessity of consuming the PartEvent content.

See gh-29400
This commit is contained in:
Arjen Poutsma 2022-11-01 17:20:01 +01:00
parent 0ef96b893b
commit 6e9fbcc243
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/docs/asciidoc/web/webflux-functional.adoc
View File

@ -259,6 +259,8 @@ allPartsEvents.windowUntil(PartEvent::isLast)
}
----
Note that the body contents of the `PartEvent` objects must be completely consumed, relayed, or released to avoid memory leaks.
[[webflux-fn-response]]
=== ServerResponse

6
src/docs/asciidoc/web/webflux.adoc
View File

@ -2855,7 +2855,7 @@ For example:
}
else if (event instanceof FilePartEvent fileEvent) { <5>
String filename = fileEvent.filename();
Flux<DataBuffer> contents = partEvents.map(PartEvent::content);
Flux<DataBuffer> contents = partEvents.map(PartEvent::content); <6>
// handle file upload
}
else {
@ -2877,6 +2877,7 @@ split events from all parts into windows that each belong to a single part.
file upload.
<4> Handling the form field.
<5> Handling the file upload.
<6> The body contents must be completely consumed, relayed, or released to avoid memory leaks.
[source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"]
.Kotlin
@ -2893,7 +2894,7 @@ file upload.
// handle form field
} else if (event is FilePartEvent) { <5>
val filename: String = event.filename();
val contents: Flux<DataBuffer> = partEvents.map(PartEvent::content);
val contents: Flux<DataBuffer> = partEvents.map(PartEvent::content); <6>
// handle file upload
} else {
return Mono.error(RuntimeException("Unexpected event: " + event));
@ -2914,6 +2915,7 @@ split events from all parts into windows that each belong to a single part.
file upload.
<4> Handling the form field.
<5> Handling the file upload.
<6> The body contents must be completely consumed, relayed, or released to avoid memory leaks.
Received part events can also be relayed to another service by using the `WebClient`.
See <<webflux-client-body-multipart>>.