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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
// -*- C++ -*-
// =========================================================================
/**
* @file AMH_Response_Handler.h
*
* @author Mayur Deshpande <mayur@ics.uci.edu>
*/
// =========================================================================
#ifndef TAO_AMH_RESPONSE_HANDLER_H
#define TAO_AMH_RESPONSE_HANDLER_H
#include "tao/Messaging/messaging_export.h"
#include "tao/Allocator.h"
#include "tao/Service_Context.h"
#include "tao/CDR.h"
#include "tao/LocalObject.h"
#include "tao/Buffer_Allocator_T.h"
#include "tao/GIOPC.h"
#include "ace/Synch_Traits.h"
#include "ace/Thread_Mutex.h"
#include "ace/Null_Mutex.h"
#include "tao/Exception.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Allocator;
ACE_END_VERSIONED_NAMESPACE_DECL
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_Transport;
class TAO_GIOP_Message_Base;
class TAO_Output_CDR;
class TAO_ORB_Core;
class TAO_ServerRequest;
typedef ACE_Allocator TAO_AMH_BUFFER_ALLOCATOR;
/**
* @class TAO_AMH_Response_Handler
*
* @brief Class representing an Asynchronous-Method-Handling (AMH)
* ResponseHandler (RH) object.
*
* Class encapsulates state required to send a response back to the
* client independent of the thread that originally created the state
* on the activation-record. Thus the required state (copied from
* TAO_Server_Request) is 'stored' on the heap.
*
* One RH is created for every client request and the RH can be used
* only once i.e., the asynchronous method can be called only once.
* This class also encapsulates various initialization and
* response-sending functionality that is common to all RHs (generated
* by the IDL compiler). Thus the IDL-compiler has to generate less
* code which in turn reduces the overall code size for an
* application.
*/
class TAO_Messaging_Export TAO_AMH_Response_Handler
: public virtual ::CORBA::LocalObject
{
public:
/// Constructor
TAO_AMH_Response_Handler ();
/// Destructor
/**
* Releases the transport and in case of an error, sends the appropriate
* exception back to the client
*/
virtual ~TAO_AMH_Response_Handler ();
/**
* Stores necessary information from a TAO_Server_Request onto the heap
*/
virtual void init (TAO_ServerRequest &server_request,
TAO_AMH_BUFFER_ALLOCATOR* allocator);
/// @name Mutators for refcount
//@{
virtual void _remove_ref ();
//@}
protected:
/// Sets up the various parameters in anticipation of returning a reply
/// to the client. return/OUT/INOUT arguments are marshalled into the
/// Output stream after this method has been called.
void _tao_rh_init_reply ();
/// Sends the marshalled reply back to the client.
void _tao_rh_send_reply ();
/// Send back an exception to the client.
void _tao_rh_send_exception (const CORBA::Exception &ex);
/// Send back a location forward exception to the client.
void _tao_rh_send_location_forward (CORBA::Object_ptr fwd,
CORBA::Boolean is_perm);
/// The outgoing CDR stream
/**
* The IDL-generated ResponseHandler implementations used this field
* to marshal the response.
* Making it a field instead of a public accessor makes the code in
* the generated ResponseHandler implementation a lot more readable.
*/
TAO_OutputCDR _tao_out;
/// Reply status (will be NO_EXCEPTION in the majority of the
GIOP::ReplyStatusType reply_status_;
private:
TAO_AMH_Response_Handler (const TAO_AMH_Response_Handler&) = delete;
TAO_AMH_Response_Handler& operator= (const TAO_AMH_Response_Handler&) = delete;
/// Pointer to the original message-base
TAO_GIOP_Message_Base *mesg_base_;
/// Copy of the request-id of the original Server-Request
CORBA::ULong request_id_;
CORBA::Boolean response_expected_;
/// Handle to transport through which the reply will be sent
/// Copy of transport in original Server_Request
TAO_Transport *transport_;
/// A pointer to the ORB Core for the context where the request was
/// created.
TAO_ORB_Core * orb_core_;
/// The reply service context
TAO_Service_Context reply_service_context_;
/// Alwyas set to true (we always have something to return to the
/// client
// @@ Mayur: I think not! This is used to generate padding in GIOP
// 1.2 messages (where the payload must start on an 8-byte
// boundary. But some replys have no payload (only header), in
// those cases you cannot insert the padding. We need the
// ResponseHandler to set this field correctly!
CORBA::Boolean argument_flag_;
/**
* Various states the ResponseHandler can be in.
*
* These states represent various states the RH can be in and
* the states are used not only in implementing the 'once-only semantics of
* RHs, but in making sure well the call thread-safe as well.
*/
enum RH_Reply_Status
{
TAO_RS_UNINITIALIZED,
TAO_RS_INITIALIZED,
TAO_RS_SENDING,
TAO_RS_SENT
};
RH_Reply_Status rh_reply_status_;
// I would use the "state pattern"..
// Carlos, Isn't that an overkill?
// @@ Mayur: it depends on what form of the "State Pattern" you
// use. The more generic form, as described in GoF, uses a class
// for each state, super-elegant but indeed a bit heavy handed.
// The lighter-weight form (using a state variable
/// Mutex to ensure the AMH-RH method call is thread-safe.
TAO_SYNCH_MUTEX mutex_;
/// Allocator used to allocate this object. If zero then we are allocated
/// from the heap
TAO_AMH_BUFFER_ALLOCATOR* allocator_;
};
namespace TAO
{
/**
* @class ARH_Refcount_Functor
*
* @brief Functor for refcounting of TAO_AMH_Response_Handler
*
* This is used to safely handle the destruction of
* TAO_AMH_Response_Handler objects which are created on the
* heap. We cannot use auto_ptr <> since it calls delete on the
* pointer, and calling delete on TAO_AMH_Response_Handler *
* will not work. Hence this functor will be used with Auto_Functor
* class to handle the memory safely.
*
* @todo Ideally, this class can be a generic class. But that
* requires quite a bit of cleanup within TAO to be more useful.
*/
class TAO_Messaging_Export ARH_Refcount_Functor
{
public:
void operator() (TAO_AMH_Response_Handler *arh) throw ();
};
}
TAO_END_VERSIONED_NAMESPACE_DECL
#endif /* TAO_AMH_RESPONSE_HANDLER_H */
|
