1
0
mirror of https://github.com/danog/parallel.git synced 2024-11-30 04:39:01 +01:00

Add more to docs

This commit is contained in:
coderstephen 2015-08-05 16:00:29 -05:00
parent d95ee80cb8
commit 09edc25348

View File

@ -11,6 +11,11 @@ use Icicle\Concurrent\Exception\LocalObjectError;
* the current thread. The object stored can be of any type, and can even be (or * the current thread. The object stored can be of any type, and can even be (or
* rather, especially) non-thread-safe or non-serializable objects. * rather, especially) non-thread-safe or non-serializable objects.
* *
* This is useful for storing references to non-thread-safe objects from within
* a thread. Normally, only thread-safe or serializable objects are allowed to
* be stored as member variables. You can wrap such objects in a `LocalObject`
* to store a reference to it safely.
*
* To access the wrapped object, you must call `LocalObject::deref()` to fetch a * To access the wrapped object, you must call `LocalObject::deref()` to fetch a
* reference to the object. If you think of a `LocalObject` as a fancy pointer * reference to the object. If you think of a `LocalObject` as a fancy pointer
* instead of an actual object, you will be less likely to forget to call * instead of an actual object, you will be less likely to forget to call