ACE_Future_Rep< T > Class Template Reference
ACE_Future_Rep<T>. More...
#include <Future.h>
Protected Member Functions | |
| ~ACE_Future_Rep (void) | |
Private Types | |
| typedef ACE_Future_Observer< T > | OBSERVER |
| typedef ACE_Unbounded_Set < OBSERVER * > | OBSERVER_COLLECTION |
Private Member Functions | |
| int | set (const T &r, ACE_Future< T > &caller) |
| int | get (T &value, ACE_Time_Value *tv) const |
| int | attach (ACE_Future_Observer< T > *observer, ACE_Future< T > &caller) |
| int | detach (ACE_Future_Observer< T > *observer) |
| operator T () | |
| void | dump (void) const |
| Dump the state of an object. | |
| int | ready (void) const |
| Is result available? | |
| ACE_Future_Rep (void) | |
Static Private Member Functions | |
| static ACE_Future_Rep< T > * | internal_create (void) |
| static ACE_Future_Rep< T > * | create (void) |
| Create a ACE_Future_Rep<T> and initialize the reference count. | |
| static ACE_Future_Rep< T > * | attach (ACE_Future_Rep< T > *&rep) |
| static void | detach (ACE_Future_Rep< T > *&rep) |
| static void | assign (ACE_Future_Rep< T > *&rep, ACE_Future_Rep< T > *new_rep) |
Private Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. | |
| T * | value_ |
| Pointer to the result. | |
| int | ref_count_ |
| Reference count. | |
| OBSERVER_COLLECTION | observer_collection_ |
| Keep a list of ACE_Future_Observers unread by client's reader thread. | |
| ACE_Recursive_Thread_Mutex | value_ready_mutex_ |
| ACE_Condition_Recursive_Thread_Mutex | value_ready_ |
Friends | |
| class | ACE_Future< T > |
Detailed Description
template<class T>
class ACE_Future_Rep< T >
ACE_Future_Rep<T>.
For internal use only.
An ACE_Future_Rep<T> object encapsules a pointer to an object of class T which is the result of an asynchronous method invocation. It is pointed to by ACE_Future<T> object[s] and only accessible through them.
Member Typedef Documentation
typedef ACE_Future_Observer<T> ACE_Future_Rep< T >::OBSERVER [private] |
typedef ACE_Unbounded_Set<OBSERVER *> ACE_Future_Rep< T >::OBSERVER_COLLECTION [private] |
Constructor & Destructor Documentation
| ACE_Future_Rep< T >::ACE_Future_Rep | ( | void | ) | [inline, private] |
| ACE_Future_Rep< T >::~ACE_Future_Rep | ( | void | ) | [inline, protected] |
Member Function Documentation
| int ACE_Future_Rep< T >::set | ( | const T & | r, | |
| ACE_Future< T > & | caller | |||
| ) | [inline, private] |
Set the result value. The specified <caller> represents the future that invoked this <set> method, which is used to notify the list of future observers. Returns 0 for success, -1 on error. This function only has an effect the first time it is called for the object. Subsequent calls return 0 (success) but have no effect.
| int ACE_Future_Rep< T >::get | ( | T & | value, | |
| ACE_Time_Value * | tv | |||
| ) | const [inline, private] |
Wait up to tv time to get the value. Note that tv must be specified in absolute time rather than relative time.
| int ACE_Future_Rep< T >::attach | ( | ACE_Future_Observer< T > * | observer, | |
| ACE_Future< T > & | caller | |||
| ) | [inline, private] |
Attaches the specified observer to a subject (i.e., the ACE_Future_Rep). The update method of the specified subject will be invoked with a copy of the written-to ACE_Future as input when the result gets set.
Returns 0 if the observer is successfully attached, 1 if the observer is already attached, and -1 if failures occur.
| int ACE_Future_Rep< T >::detach | ( | ACE_Future_Observer< T > * | observer | ) | [inline, private] |
Detaches the specified observer from a subject (i.e., the ACE_Future_Rep). The update method of the specified subject will not be invoked when the ACE_Future_Reps result gets set. Returns 1 if the specified observer was actually attached to the subject prior to this call and 0 if was not.
Returns 0 if the observer was successfully detached, and -1 if the observer was not attached in the first place.
| ACE_Future_Rep< T >::operator T | ( | ) | [inline, private] |
Type conversion. will block forever until the result is available. Note that this method is going away in a subsequent release since it doesn't distinguish between failure results and success results (exceptions should be used, but they aren't portable...). The <get> method should be used instead since it separates the error value from the result, and also permits timeouts.
| void ACE_Future_Rep< T >::dump | ( | void | ) | const [inline, private] |
Dump the state of an object.
| ACE_Future_Rep< T > * ACE_Future_Rep< T >::internal_create | ( | void | ) | [inline, static, private] |
Allocate a new ACE_Future_Rep<T> instance, returning NULL if it cannot be created.
| ACE_Future_Rep< T > * ACE_Future_Rep< T >::create | ( | void | ) | [inline, static, private] |
Create a ACE_Future_Rep<T> and initialize the reference count.
| ACE_Future_Rep< T > * ACE_Future_Rep< T >::attach | ( | ACE_Future_Rep< T > *& | rep | ) | [inline, static, private] |
Increase the reference count and return argument. Uses the attribute "value_ready_mutex_" to synchronize reference count updating.
Precondition (rep != 0).
| void ACE_Future_Rep< T >::detach | ( | ACE_Future_Rep< T > *& | rep | ) | [inline, static, private] |
Decreases the reference count and deletes rep if there are no more references to rep.
Precondition (rep != 0)
| void ACE_Future_Rep< T >::assign | ( | ACE_Future_Rep< T > *& | rep, | |
| ACE_Future_Rep< T > * | new_rep | |||
| ) | [inline, static, private] |
Decreases the rep's reference count and deletes rep if there are no more references to rep. Then assigns new_rep to rep.
Precondition (rep != 0 && new_rep != 0)
| int ACE_Future_Rep< T >::ready | ( | void | ) | const [inline, private] |
Is result available?
Friends And Related Function Documentation
friend class ACE_Future< T > [friend] |
Member Data Documentation
ACE_Future_Rep< T >::ACE_ALLOC_HOOK_DECLARE [private] |
Declare the dynamic allocation hooks.
T* ACE_Future_Rep< T >::value_ [private] |
Pointer to the result.
int ACE_Future_Rep< T >::ref_count_ [private] |
Reference count.
OBSERVER_COLLECTION ACE_Future_Rep< T >::observer_collection_ [private] |
Keep a list of ACE_Future_Observers unread by client's reader thread.
ACE_Recursive_Thread_Mutex ACE_Future_Rep< T >::value_ready_mutex_ [mutable, private] |
ACE_Condition_Recursive_Thread_Mutex ACE_Future_Rep< T >::value_ready_ [mutable, private] |
The documentation for this class was generated from the following files:
