diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | ChangeLogs/ChangeLog-02a | 6 | ||||
| -rw-r--r-- | ChangeLogs/ChangeLog-03a | 6 | ||||
| -rw-r--r-- | THANKS | 2 | ||||
| -rw-r--r-- | ace/Future_Set.h | 26 |
5 files changed, 40 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog index 0bb205c8c9e..d7a2e22d284 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Sat Jan 19 10:23:39 2002 Douglas C. Schmidt <schmidt@macarena.cs.wustl.edu> + + * ace/Future_Set.h: Updated the documentation to explain how + various features work better. Thanks to Johnny Tucker for + contributing this. + Fri Jan 18 19:09:41 2002 Steve Huston <shuston@riverace.com> * tests/run_test.lst: Re-enabled Process_Manager_Test for all but diff --git a/ChangeLogs/ChangeLog-02a b/ChangeLogs/ChangeLog-02a index 0bb205c8c9e..d7a2e22d284 100644 --- a/ChangeLogs/ChangeLog-02a +++ b/ChangeLogs/ChangeLog-02a @@ -1,3 +1,9 @@ +Sat Jan 19 10:23:39 2002 Douglas C. Schmidt <schmidt@macarena.cs.wustl.edu> + + * ace/Future_Set.h: Updated the documentation to explain how + various features work better. Thanks to Johnny Tucker for + contributing this. + Fri Jan 18 19:09:41 2002 Steve Huston <shuston@riverace.com> * tests/run_test.lst: Re-enabled Process_Manager_Test for all but diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a index 0bb205c8c9e..d7a2e22d284 100644 --- a/ChangeLogs/ChangeLog-03a +++ b/ChangeLogs/ChangeLog-03a @@ -1,3 +1,9 @@ +Sat Jan 19 10:23:39 2002 Douglas C. Schmidt <schmidt@macarena.cs.wustl.edu> + + * ace/Future_Set.h: Updated the documentation to explain how + various features work better. Thanks to Johnny Tucker for + contributing this. + Fri Jan 18 19:09:41 2002 Steve Huston <shuston@riverace.com> * tests/run_test.lst: Re-enabled Process_Manager_Test for all but @@ -664,7 +664,7 @@ Gildo Medeiros Junior <gildo@siemens.com.br> Brian Peterson <bpeterson@globalmt.com> Fabrice Podlyski <podlyski@clrhp04.in2p3.fr> Darren DeRidder <darren.deridder@bridgewatersys.com> -John Tucker <jtucker@magisnetworks.com> +John Tucker <johnny_tucker@yahoo.com> Oleg Orlov <orlov@diasoft.ru> Timothy Canham <Timothy.Canham@jpl.nasa.gov> Randy Heiland <heiland@ncsa.uiuc.edu> diff --git a/ace/Future_Set.h b/ace/Future_Set.h index b79241dfa14..f776d240177 100644 --- a/ace/Future_Set.h +++ b/ace/Future_Set.h @@ -29,8 +29,13 @@ * @class ACE_Future_Set * * @brief This class implements a mechanism which allows the values of - * a collections of <ACE_Future> objects to be accessed by - * reader threads as they become available. + * a collection of <ACE_Future> objects to be accessed by reader threads + * as they become available. The caller(s) provide the <ACE_Future_Set> + * (i.e. the observer...) with the collection of <ACE_Future> objects + * (i.e. the subjects...) that are to be observed using the + * the <ACE_Future_Set::insert> method. The caller(s) may then iterate + * over the collection in the order in which they become readable using + * the <ACE_Future_Set::next_readable> method. */ template <class T> class ACE_Future_Set : public ACE_Future_Observer<T> @@ -46,6 +51,12 @@ public: /// Return 1 if their are no <ACE_Future> objects left on its queue and /// 0 otherwise + /// + /// When an <ACE_Future_Set> has no <ACE_Future> subjects to observe it is + /// empty. The <ACE_Future_Set> is in the empty state when either the caller(s) + /// have retrieved every readable <ACE_Future> subject assigned the + /// <ACE_Future_Set> via the <ACE_Future_Set::next_readable> method, + /// or when the <ACE_Future_Set> has not been assigned any subjects. int is_empty (void) const; /** @@ -63,9 +74,14 @@ public: * next <ACE_Future> that is readable. If <tv> = 0, the will block * forever. * - * If a readable future becomes available, then the input result - * will be assigned with it and 1 will will be returned. If the set - * is empty, then 0 is returned. + * If a readable future becomes available, then the input + * <ACE_Future> object param will be assigned with it and 1 will + * be returned. If the <ACE_Future_Set> is empty (i.e. see definition + * of <ACE_Future_Set::is_empty>), then 0 is returned. + * + * When a readable <ACE_Future> object is retrieved via the + * <ACE_Future_Set::next_readable> method, the <ACE_Future_Set> will + * remove that <ACE_Future> object from its list of subjects. */ int next_readable (ACE_Future<T> &result, ACE_Time_Value *tv = 0); |