ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-20 13:33:09 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Some documentation for QueueMixin

Browse Source
This commit is contained in:
meejah 2018-02-20 15:59:15 -07:00
parent 472d6ba78b
commit 1b16e1f792
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/allmydata/frontends/magic_folder.py
View File

@ -303,6 +303,23 @@ class MagicFolder(service.MultiService):
class QueueMixin(HookMixin): class QueueMixin(HookMixin):
"""
A parent class for Uploader and Downloader that handles putting
IQueuedItem instances into a work queue and processing
them. Tracks some history of recent items processed (for the
"status" API).
Subclasses implment _scan_delay, _perform_scan and _process
:ivar _deque: IQueuedItem instances to process
:ivar _process_history: the last 20 items we processed
:ivar _in_progress: current batch of items which are currently
being processed; chunks of work are removed from _deque and
worked on. As each finishes, it is added to _process_history
(with oldest items falling off the end).
"""
def __init__(self, client, local_path_u, db, name, clock): def __init__(self, client, local_path_u, db, name, clock):
self._client = client self._client = client