Roots contain cached statistics and recovery information.
Because there is only a single root at any time, the root is not named. Instead, it is accessed via FMTCRoot
- and all members are static.
After the root reference is constructed, the following actions can be performed with it:
Management of the root is not provided by FMTCRoot
. Instead, the backend should implement any necessary methods.
RootRecovery
, accessed via FMTCRoot.recovery
, allows access to the bulk download recovery system, which is designed to allow rescue (salvation and restarting) of failed downloads when they crashed due to an unexpected event.
RecoveredRegion
RecoveredRegion
s are wrappers containing recovery & some downloadable region information, around a DownloadableRegion
.
Once a RecoveredRegion
has been retreived, it contains the original BaseRegion
in the region
property.
To create a DownloadableRegion
using the other available information with a provided TileLayer
, use toDownloadable
.
A RecoveredRegion
(and a DownloadableRegion
generated from it) will point to only any remaining, un-downloaded tiles from the failed download.
The start
tile will be adjusted from the original to reflect the progress of the download before it failed, meaning that tiles already successfully cached (excluding buffered) will not be downloaded again, saving time and network transfers.
The end
tile will be either the original, or the maximum number of tiles normally in the region (which will have no resulting difference than null
, but allows for a quick estimate of the number of remaining tiles to be made without needing to recheck
the entire region).
RootStats
, accessed via FMTCRoot.stats
, allows access to cached statistics, as well as listing of all existing stores, and the watching over changes in multiple/all stores and the bulk download recovery system.
Remember that the size
and length
statistics in the root may not be equal to the sum of the same statistics of all available stores, because tiles may belong to many stores, and these statistics do not count any tile multiple times.
Statistics: stats
Retrieve information about the store and its contents
Recovery: recovery
Recovery from unexpectedly failed bulk downloads
External: external
Export & import store archives