summaryrefslogtreecommitdiff
path: root/indra/llcommon/llevents.h
diff options
context:
space:
mode:
authorBrad Payne (Vir Linden) <vir@lindenlab.com>2016-05-06 11:00:47 -0400
committerBrad Payne (Vir Linden) <vir@lindenlab.com>2016-05-06 11:00:47 -0400
commit2d8b53854ebc1db5cceda1e1b5d6abbbc6c08728 (patch)
tree56388b12b66b42059841faeadac6f110abc18d21 /indra/llcommon/llevents.h
parente0cb5438a5055c71191c6ae6b27c7dee63e40562 (diff)
parent94559950a2c670990db56bd74e65d26652421b8c (diff)
merge
Diffstat (limited to 'indra/llcommon/llevents.h')
-rwxr-xr-xindra/llcommon/llevents.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/indra/llcommon/llevents.h b/indra/llcommon/llevents.h
index 6175329a9d..ba4fcd766e 100755
--- a/indra/llcommon/llevents.h
+++ b/indra/llcommon/llevents.h
@@ -616,6 +616,12 @@ public:
* a queue. Subsequent attaching listeners will receive stored events from the queue
* until a listener indicates that the event has been handled. In order to receive
* multiple events from a mail drop the listener must disconnect and reconnect.
+ *
+ * @NOTE: When using an LLEventMailDrop (or LLEventQueue) with a LLEventTimeout or
+ * LLEventFilter attaching the filter downstream using Timeout's constructor will
+ * cause the MailDrop to discharge any of it's stored events. The timeout should
+ * instead be connected upstream using its listen() method.
+ * See llcoro::suspendUntilEventOnWithTimeout() for an example.
*/
class LL_COMMON_API LLEventMailDrop : public LLEventStream
{