mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-04-20 16:00:20 +00:00
Code Issues Projects Releases Wiki Activity

AsyncTask: Remove a bunch of reference-management drivel from documentation of storeLocal()

Browse Source 
this works (mostly) the same way regular properties do, so the usual rules are implied.
This commit is contained in:
Dylan K. Taylor 2019-07-27 14:52:53 +01:00
parent e75a08a5a3
commit cb40484a2e
1 changed files with 0 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/pocketmine/scheduler/AsyncTask.php
View File

@ -229,13 +229,6 @@ abstract class AsyncTask extends Collectable{
* Objects stored in this storage MUST be retrieved through {@link AsyncTask::fetchLocal} when {@link AsyncTask::onCompletion} is called.
* Otherwise, a NOTICE level message will be raised and the reference will be removed after onCompletion exits.
*
* WARNING: Use this method carefully. It might take a long time before an AsyncTask is completed. PocketMine will
* keep a strong reference to objects passed in this method. This may result in a light memory leak. Usually this
* does not cause memory failure, but be aware that the object may be no longer usable when the AsyncTask completes.
* (E.g. a Level object is no longer usable because it is unloaded while the AsyncTask is executing, or even a
* plugin might be unloaded). Since PocketMine keeps a strong reference, the objects are still valid, but the
* implementation is responsible for checking whether these objects are still usable.
*
* WARNING: THIS METHOD SHOULD ONLY BE CALLED FROM THE MAIN THREAD!
*
* @param mixed $complexData the data to store