blob: 1e56a409c81bc2ae9b1c034b2ce6258d622d8682 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
// -*- C++ -*-
//=============================================================================
/**
* @file LF_Invocation_Event.h
*
* @author Carlos O'Ryan <coryan@uci.edu>
*/
//=============================================================================
#ifndef TAO_LF_INVOCATION_EVENT_H
#define TAO_LF_INVOCATION_EVENT_H
#include /**/ "ace/pre.h"
#include "tao/LF_Event.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class TAO_LF_Invocation_Event
*
* @brief Use the Leader/Follower loop to wait for one specific event
* in the invocation path.
*
* Concrete event types and manipulation class through which the
* invocation data path would flow. Typically state changes of
* interest include whether a message has arrived, or timedout waiting
* for a message or if the connection is closed waiting for a
* message. Details of the states are documented within the class.
*/
class TAO_Export TAO_LF_Invocation_Event: public TAO_LF_Event
{
public:
/// Constructor
TAO_LF_Invocation_Event (void);
/// Destructor
virtual ~TAO_LF_Invocation_Event (void);
protected:
/// Validate and perform the state change
/**
* This concrete class uses the following states declared in the
* class TAO_LF_Event
*
* LFS_IDLE - The event is created, and is in initial state.
* LFS_ACTIVE - The event is active and it can transition to any of
* the following states, all the states are final.
* LFS_SUCCESS - The event has completed successfully.
* LFS_FAILURE - A failure has been detected while the event was
* active.
* LFS_TIMEOUT - The event has timed out.
* LFS_CONNECTION_CLOSED - The connection was closed when the state
* was active.
*/
virtual void state_changed_i (LFS_STATE new_state);
/// Return true if the condition was satisfied successfully, false if it
/// has not
virtual bool successful_i (void) const;
/// Return true if an error was detected while waiting for the
/// event
virtual bool error_detected_i (void) const;
private:
/// Check whether we have reached the final state..
bool is_state_final (void) const;
};
TAO_END_VERSIONED_NAMESPACE_DECL
#include /**/ "ace/post.h"
#endif /* TAO_LF_INVOCATION_EVENT_H */
|
