Ktor 1.6.4 Help

DoubleReceive

The DoubleReceive plugin (previously known as feature) provides the ability to invoke ApplicationCall.receive several times with no RequestAlreadyConsumedException exception. This usually makes sense when a plugin is consuming a request body so a handler is unable to receive it again.

Usage

Install DoubleReceive plugin into the ApplicationCall

install(DoubleReceive)

After that you can receive from a call multiple times and every invocation may return the same instance.

val first = call.receiveText() val theSame = call.receiveText()

Types that could be always received twice with this plugin are: ByteArray, String and Parameters and all types provided by ContentNegotiation plugin (for example, objects deserialized from JSON payloads).

Receiving different types from the same call is not guaranteed to work without receiveEntireContent but may work in some specific cases. For example, receiving a text after receiving a byte array always works.

When receiveEntireContent is enabled, then receiving different types should always work. Also double receive of a channel or stream works as well. However, receive executes the whole receive pipeline from the beginning so all content transformations and converters are executed every time that may be slower than with the option disabled.

Comparison:

receiveEntireContentsame typedifferent typechannel
enabledre-runyes, re-runyes
disabledcached same instancegenerally nono

Custom types

If a custom content transformation is installed (for example, by intercepting receive pipeline), then a transformed value couldn't be re-received without receiveEntireContent option by default. However, it is possible to mark a transformed value object as reusable by specifying reusableValue option:

val converted = .... // convert somehow from a request payload proceedWith(ApplicationReceiveRequest(receive.typeInfo, converted, reusableValue = true))

Options

  • receiveEntireContent When enabled, for every request the whole content will be received and stored as a byte array. This is useful when completely different types need to be received. You also can receive streams and channels. Note that enabling this causes the whole receive pipeline to be executed for every further receive pipeline.

Last modified: 09 September 2021