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

Fix style in Request Life Cycle section.

Browse Source 
Co-authored-by: pancho horrillo <pedrofelipe.horrillo@bbva.com>
This commit is contained in:
Roberto Abdelkader Martínez Pérez
2019-11-22 09:32:26 +01:00
parent 8474f31747
commit 9aad5aa70f
1 changed files with 26 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/theory/request_life_cycle.rst
+26 -22
View File
@@ -8,49 +8,53 @@ answered by the `User HTTP Interface`.
1. request 1. request
----------
The user makes a request to the `User HTTP Interface`. 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. spawn 2. spawn
--------
``kapow`` spawns the executable specified as entrypoint in the matching ``kapow`` spawns the executable specified as entrypoint in the matching
route. route.
The default entrypoint is ``/bin/sh``; we'll explain this workflow for now. 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 HTTP Interface` - ``KAPOW_DATAAPI_URL``: With the URL of the `Data HTTP Interface`
- ``KAPOW_CONTROLAPI_URL``: With the URL of the `Control HTTP Interface` - ``KAPOW_CONTROLAPI_URL``: With the URL of the `Control HTTP Interface`
3. ``kapow set /response/body banana`` 3. ``kapow set /response/body banana``
--------------------------------------
During the lifetime of the shell, the request and response resources are During the lifetime of the shell, the request and response resources are
available via these commands: 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 These commands use the aforementioned environment variables to read data
the user request and to write the response. from the user request and to write the response. They accept data
either as arguments or from ``stdin``.
- They accept data either as arguments or from stdin.
4. exit 4. exit
-------
The shell dies. The shell dies.
5. response 5. response
-----------
``kapow`` finalizes the original request. ``kapow`` finalizes the original request.
.. todo:: .. todo::