Add documentation for order of termination
This commit is contained in:
parent
84ae1cb5b7
commit
38e0a4759b
|
@ -2,12 +2,13 @@
|
||||||
// datastores (tusd.DataStore) while limiting the used storage size.
|
// datastores (tusd.DataStore) while limiting the used storage size.
|
||||||
// It will start terminating existing uploads if not enough space is left in
|
// It will start terminating existing uploads if not enough space is left in
|
||||||
// order to create a new upload.
|
// order to create a new upload.
|
||||||
|
// The order in which the uploads will be terminated is defined by their size,
|
||||||
|
// whereas the biggest ones are deleted first.
|
||||||
// This package's functionality is very limited and naive. It will terminate
|
// This package's functionality is very limited and naive. It will terminate
|
||||||
// uploads whether they are finished yet or not and it won't terminate them
|
// uploads whether they are finished yet or not. Only one datastore is allowed to
|
||||||
// intelligently (e.g. bigger uploads first). Only one datastore is allowed to
|
|
||||||
// access the underlying storage else the limited store will not function
|
// access the underlying storage else the limited store will not function
|
||||||
// properly. Two tusd.FileStore instances using the same directory, for example.
|
// properly. Two tusd.FileStore instances using the same directory, for example.
|
||||||
// In addition the limited store will keep a list of the uploads' ids in memory
|
// In addition the limited store will keep a list of the uploads' IDs in memory
|
||||||
// which may create a growing memory leak.
|
// which may create a growing memory leak.
|
||||||
package limitedstore
|
package limitedstore
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue