Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: update request_life_cycle.rst

Browse Source
This commit is contained in:
pancho horrillo
2019-11-22 09:20:29 +01:00
parent 24cc530a0e
commit 8474f31747
1 changed files with 27 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/theory/request_life_cycle.rst
+27 -10
View File
@@ -2,38 +2,55 @@ Request Life Cycle
================== ==================
This section describes the sequence of events happening for each request This section describes the sequence of events happening for each request
answered by the User HTTP Interface. answered by the `User HTTP Interface`.
.. image:: ../_static/request_life_cycle.png .. image:: ../_static/request_life_cycle.png
1. The user makes a request to the User HTTP Interface 1. request
The user makes a request to the `User HTTP Interface`.
- The request is matched against the route table - The request is matched against the route table
- ``kapow`` provides a `HANDLER_ID` to identify this request and don't mix it - ``kapow`` provides a `HANDLER_ID` to identify this request and don't mix it
with other requests that could be running concurrently. with other requests that could be running concurrently.
2. ``kapow`` spawns the binary specified as entrypoint in the matching route 2. spawn
The default entrypoint is /bin/sh; we'll explain this workflow for now. ``kapow`` spawns the executable specified as entrypoint in the matching
route.
The default entrypoint is ``/bin/sh``; we'll explain this workflow for now.
The spawned entrypoint is run with the following variables added to its The spawned entrypoint is run with the following variables added to its
environment: environment:
- ``KAPOW_HANDLER_ID``: Containing the `HANDLER_ID` - ``KAPOW_HANDLER_ID``: Containing the `HANDLER_ID`
- ``KAPOW_DATAAPI_URL``: With the URL of the `data interface` - ``KAPOW_DATAAPI_URL``: With the URL of the `Data HTTP Interface`
- ``KAPOW_CONTROLAPI_URL``: With the URL of the `control interface` - ``KAPOW_CONTROLAPI_URL``: With the URL of the `Control HTTP Interface`
3. During the lifetime of the shell, the request and response resources are available via these commands: 3. ``kapow set /response/body banana``
During the lifetime of the shell, the request and response resources are
available via these commands:
- ``kapow get /request/...`` - ``kapow get /request/...``
- ``kapow set /response/...`` - ``kapow set /response/...``
These commands use the aforementioned environment variables to read data from the user request and to write the response. - These commands use the aforementioned environment variables to read data from
the user request and to write the response.
4. The shell dies - They accept data either as arguments or from stdin.
5. ``kapow`` finalizes the original request
4. exit
The shell dies.
5. response
``kapow`` finalizes the original request.
.. todo:: .. todo::