summaryrefslogtreecommitdiff
path: root/indra/llcommon/llevents.h
diff options
context:
space:
mode:
authorGlenn Glazer <coyot@lindenlab.com>2016-05-10 14:59:33 -0700
committerGlenn Glazer <coyot@lindenlab.com>2016-05-10 14:59:33 -0700
commitdf55966b112142e194f07386a3673f395ec792fc (patch)
tree481234ace0fa5a95c0f135b7aa35872a8fa1946d /indra/llcommon/llevents.h
parenta670914c6d43dcde0677680375f53f8a67a89cf6 (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
{