github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

Document that libaria2 is not thread safe

pull/782/head
Tatsuhiro Tsujikawa 2016-11-16 22:10:42 +09:00
parent e12693c027
commit 9d58ad912a
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/manual-src/en/libaria2.rst
View File

@ -54,12 +54,14 @@ And create aria2 session object::
:type:`Session` ``session`` is an aria2 session object. You need this :type:`Session` ``session`` is an aria2 session object. You need this
object through out the download process. Please keep in mind that only object through out the download process. Please keep in mind that only
one :type:`Session` object can be allowed per process due to the heavy one :type:`Session` object can be allowed per process due to the heavy
use of static objects in aria2 code base. :type:`SessionConfig` use of static objects in aria2 code base. :type:`Session` object is
``config`` holds configuration for the session object. The constructor not safe for concurrent accesses from multiple threads. It must be
initializes it with the default values. In this setup, used from one thread at a time. In general, libaria2 is not entirely
:member:`SessionConfig::keepRunning` is ``false`` which means thread-safe. :type:`SessionConfig` ``config`` holds configuration for
:func:`run()` returns when all downloads are processed, just like the session object. The constructor initializes it with the default
aria2c utility without RPC enabled. And values. In this setup, :member:`SessionConfig::keepRunning` is
``false`` which means :func:`run()` returns when all downloads are
processed, just like aria2c utility without RPC enabled. And
:member:`SessionConfig::useSignalHandler` is ``true``, which means :member:`SessionConfig::useSignalHandler` is ``true``, which means
libaria2 will setup signal handlers and catches certain signals to libaria2 will setup signal handlers and catches certain signals to
halt download process gracefully. We also setup event handler callback halt download process gracefully. We also setup event handler callback