Skip to content

Commit

Permalink
📝 docs(ktor-custom-plugin): updates client pipelines description
Browse files Browse the repository at this point in the history
  • Loading branch information
franciscoengenheiro committed Apr 13, 2024
1 parent 9f2ac0e commit 5cd099d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
Binary file modified docs/imgs/ktor-server-pipeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions ktor-custom-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,24 +217,24 @@ Available pipelines in `ktor-client` are:
- `Render`: Encode a request body to `OutgoingContent`;
- `Send`: A phase for the `HttpSend` plugin.
- [HttpSendPipeline](https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.request/-http-send-pipeline/-phases/index.html):
A pipeline used for sending a request.It has the following phases:
A pipeline used for sending a request. It has the following phases:
- `Before`: The earliest phase that happens before any other;
- `State`: Use this phase to modify a request with a shared state;
- `Monitoring`: Use this phase for logging and other actions that don't modify a request or shared data;
- `Engine`: Send a request to a remote server;
- `Receive`: Receive a pipeline execution phase.
- [HttpReceivePipeline](https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.statement/-http-receive-pipeline/-phases/index.html):
A pipeline used for receiving a response without processing. It has the following phases:
- `Before`: The earliest phase that happens before any other;
- `State`: Use this phase to store request shared state;
- `After`: Latest response pipeline phase.
- [HttpResponsePipeline](https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.statement/-http-response-pipeline/-phases/index.html):
A pipeline used for processing responses. It has the following phases:
- `Receive`: The earliest phase that happens before any other;
- `Parse`: Decode response body;
- `Transform`: Transform response body to expected format;
- `State`: Use this phase to store request shared state;
- `After`: Latest response pipeline phase
- [HttpReceivePipeline](https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.statement/-http-receive-pipeline/-phases/index.html):
A pipeline used for receiving a request. It has the following phases:
- `Before`: The earliest phase that happens before any other;
- `State`: Use this phase to store request shared state;
- `After`: Latest response pipeline phase
- `After`: Latest response pipeline phase.

| ![Client Pipelines](../docs/imgs/ktor-client-pipelines.png) |
|:-----------------------------------------------------------:|
Expand Down

0 comments on commit 5cd099d

Please sign in to comment.