diff options
author | adamw <adam@warski.org> | 2017-10-17 17:28:50 +0200 |
---|---|---|
committer | adamw <adam@warski.org> | 2017-10-17 17:28:50 +0200 |
commit | 6e109a964383bfe5e2be04f65fa7cc1356a97cbe (patch) | |
tree | 7764ff94d72e0ffbf1e593fb8c5886562dc57f33 /docs/backends/start_stop.rst | |
parent | 06bd5c95d04dd57e1b6c2572b94336b8fdb68bfa (diff) | |
download | sttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.tar.gz sttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.tar.bz2 sttp-6e109a964383bfe5e2be04f65fa7cc1356a97cbe.zip |
More docs
Diffstat (limited to 'docs/backends/start_stop.rst')
-rw-r--r-- | docs/backends/start_stop.rst | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/docs/backends/start_stop.rst b/docs/backends/start_stop.rst index 6cd6f13..ed117a7 100644 --- a/docs/backends/start_stop.rst +++ b/docs/backends/start_stop.rst @@ -1,17 +1,9 @@ Starting & cleaning up ====================== -In case of most backends, you should only instantiate a backend once per -application, as a backend typically allocates resources such as thread or -connection pools. +In case of most backends, you should only instantiate a backend once per application, as a backend typically allocates resources such as thread or connection pools. -When ending the application, make sure to call ``backend.close()``, which will -free up resources used by the backend (if any). The close process might be -asynchronous, that is it can complete after the ``close()`` method returns. +When ending the application, make sure to call ``backend.close()``, which will free up resources used by the backend (if any). The close process might be asynchronous, that is it can complete after the ``close()`` method returns. -Note that only resources allocated by the backends are freed. For example, -if you use the ``AkkaHttpBackend()`` the ``close()`` method will terminate the -underlying actor system. However, if you have provided an existing actor system -upon backend creation (``AkkaHttpBackend.usingActorSystem``), the ``close()`` -method will be a no-op. +Note that only resources allocated by the backends are freed. For example, if you use the ``AkkaHttpBackend()`` the ``close()`` method will terminate the underlying actor system. However, if you have provided an existing actor system upon backend creation (``AkkaHttpBackend.usingActorSystem``), the ``close()`` method will be a no-op. |