public static final class HttpEntity.HttpEntityScalaDSLSugar
extends scala.AnyVal
HttpEntity, e.g. versions of methods with an implicit Materializer.| Constructor and Description |
|---|
HttpEntityScalaDSLSugar(HttpEntity httpEntity) |
| Modifier and Type | Method and Description |
|---|---|
HttpMessage.DiscardedEntity |
discardBytes(org.apache.pekko.stream.Materializer mat)
Discards the entities data bytes by running the
dataBytes Source contained in this entity. |
HttpEntity |
httpEntity() |
public HttpEntityScalaDSLSugar(HttpEntity httpEntity)
public HttpEntity httpEntity()
public HttpMessage.DiscardedEntity discardBytes(org.apache.pekko.stream.Materializer mat)
dataBytes Source contained in this entity.
Note: It is crucial that entities are either discarded, or consumed by running the underlying pekko.stream.scaladsl.Source
as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection
(as designed), however possibly leading to an idle-timeout that will close the connection, instead of
just having ignored the data.
Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once
as the stream is directly attached to the "live" incoming data source from the underlying TCP connection.
Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose
of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an
"stream can cannot be materialized more than once" exception.
In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.
mat - (undocumented)