Skip to content

Commit

Permalink
[skip ci] async doc suite
Browse files Browse the repository at this point in the history
  • Loading branch information
jcheron committed Sep 28, 2020
1 parent 3bcf9de commit 3a68af3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
13 changes: 8 additions & 5 deletions docs/extra/async.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ Async platforms

<br />

.. note:: This part is accessible from the **webtools**, so if you created your project with the **-a** option or with the **create-project** command..

Ubiquity supports multiple platforms : Swoole, Workerman, RoadRunner, PHP-PM, ngx_php.

Swoole
Expand All @@ -19,7 +17,7 @@ Install the Swoole extension on your system (linux) or in your Docker image :
#!/bin/bash
pecl install swoole
Run Ubiquity Swoole (for the first time, Ubiquity-swoole package will be installed):
Run Ubiquity Swoole (for the first time, **ubiquity-swoole** package will be installed):

.. code-block:: bash
Expand Down Expand Up @@ -70,6 +68,11 @@ Startup of services will be done only once, at server startup.
\controllers\IndexController::warmup();
\controllers\FooController::warmup();
});
The warmUpControllers method:
- instantiates the controllers
- performs dependency injection
- prepares the call of the initialize and finalize methods (initialization of call constants)

At the start of each Worker, the **warmup** method of the controllers can for example initialize prepared DAO queries:

Expand All @@ -84,10 +87,10 @@ At the start of each Worker, the **warmup** method of the controllers can for ex
Workerman
---------

Workerman does not require any special installation (except for libevent to be used in production for performance reasons).
Workerman does not require any special installation (except for **libevent** to be used in production for performance reasons).


Run Ubiquity Workerman (for the first time, Ubiquity-workerman package will be installed):
Run Ubiquity Workerman (for the first time, **ubiquity-workerman** package will be installed):

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Ubiquity User guide

.. sidebar:: New in documentation

- :ref:`Async platforms module<async>`
- :ref:`Async platforms<async>`
- :ref:`Commands module<commands>`
- :ref:`Composer module<composer>`
- :ref:`OAuth client module<oauth>`
Expand Down

0 comments on commit 3a68af3

Please sign in to comment.