From 7876dad0914fef3ff9c05d615f7e10d8926ef289 Mon Sep 17 00:00:00 2001 From: Johannes Schanda Date: Thu, 5 Sep 2013 16:03:56 +0200 Subject: Add comment to subscription --- src/CommonAPI/SelectiveEvent.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/CommonAPI/SelectiveEvent.h b/src/CommonAPI/SelectiveEvent.h index 11612c3..c430e8d 100644 --- a/src/CommonAPI/SelectiveEvent.h +++ b/src/CommonAPI/SelectiveEvent.h @@ -30,6 +30,21 @@ public: bool success; return subscribe(listener, success); } + + /** + * \brief Subscribe a listener to this event and be notified of success + * + * Subscribe a listener to this event and be notified of success via the passed reference. + * ATTENTION: You should not build new proxies or register services in callbacks + * from events. This can cause a deadlock or assert. Instead, you should set a + * trigger for your application to do this on the next iteration of your event loop + * if needed. The preferred solution is to build all proxies you need at the + * beginning and react to events appropriatly for each. + * + * @param listener A listener to be added + * @param success Indicates whether subscription was accepted + * @return A token identifying this subscription + */ virtual Subscription subscribe(Listener listener, bool& success) = 0; }; -- cgit v1.2.1