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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
// -*- C++ -*-
//=============================================================================
/**
* @file Servant_Base.h
*
* $Id$
*
* @author Irfan Pyarali <irfan@cs.wustl.edu>
*/
//=============================================================================
#ifndef TAO_SERVANT_BASE_H
#define TAO_SERVANT_BASE_H
#include /**/ "ace/pre.h"
#include "tao/PortableServer/portableserver_export.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "tao/PortableServer/PS_ForwardC.h"
#include "tao/PortableServer/Servant_var.h"
#include "tao/Abstract_Servant_Base.h"
#include "ace/Atomic_Op.h"
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_Operation_Table;
/**
* @class TAO_ServantBase
*
* @brief Base class for skeletons and servants.
*
* The POA spec requires that all servants inherit from this class'
* base class.
*
* An instance of a servant class derived from
* ServantBase initially has a reference count of
* one. Invoking _add_ref on the servant instance increases its
* reference count by one. Invoking _remove_ref on the servant
* instance decreases its reference count by one; if the
* resulting reference count equals zero, _remove_ref invokes
* delete on its this pointer in order to destroy the
* servant. For ORBs that operate in multi-threaded
* environments, the implementations of _add_ref and _remove_ref
* that the ServantBase class provides shall be
* thread-safe.
*
* Like ServantBase supports copy
* construction and the default assignment operation. Copy
* construction always sets the reference count of the new
* servant instance to one. The default assignment
* implementation merely returns *this and does not affect the
* reference count.
*
*/
class TAO_PortableServer_Export TAO_ServantBase
: public virtual TAO_Abstract_ServantBase
{
public:
/// Useful for template programming.
typedef CORBA::Object _stub_type;
typedef CORBA::Object_ptr _stub_ptr_type;
typedef CORBA::Object_var _stub_var_type;
/// Destructor.
virtual ~TAO_ServantBase (void);
static void _is_a_skel (TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
static void _is_a_thru_poa_skel (TAO_ServerRequest & server_request,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
#if (TAO_HAS_MINIMUM_CORBA == 0)
static void _non_existent_skel (TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
static void _non_existent_thru_poa_skel (TAO_ServerRequest & server_request,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
# if !defined (CORBA_E_COMPACT) && !defined (CORBA_E_MICRO)
static void _interface_skel (TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
static void _component_skel (TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
static void _component_thru_poa_skel (TAO_ServerRequest & server_request,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
# endif /* !defined (CORBA_E_COMPACT) && !defined (CORBA_E_MICRO) */
static void _repository_id_skel (TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
static void _repository_id_thru_poa_skel (TAO_ServerRequest & server_request,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *servant);
#endif /* TAO_HAS_MINIMUM_CORBA */
/// Returns the default POA for this servant.
virtual PortableServer::POA_ptr _default_POA (void);
/// Local implementation of the CORBA::Object::_is_a method.
virtual CORBA::Boolean _is_a (const char *logical_type_id);
#if (TAO_HAS_MINIMUM_CORBA == 0)
/// Default _non_existent: always returns false.
virtual CORBA::Boolean _non_existent (void);
/// Query the Interface Repository for the interface definition.
virtual CORBA::InterfaceDef_ptr _get_interface (void);
#if !defined (CORBA_E_COMPACT) && !defined (CORBA_E_MICRO)
/// Default _get_component: always returns CORBA::Object::_nil().
virtual CORBA::Object_ptr _get_component (void);
#endif
/// Get the repository id.
virtual char * _repository_id (void);
#endif /* TAO_HAS_MINIMUM_CORBA */
/// This is an auxiliary method for _this() and _narrow().
virtual TAO_Stub *_create_stub (void);
/**
* Dispatches a request to the object: find the operation, cast the
* type to the most derived type, demarshall all the parameters from
* the request and finally invokes the operation, storing the
* results and out parameters (if any) or the exceptions thrown into
* @a request.
*/
virtual void _dispatch (
TAO_ServerRequest &request,
TAO::Portable_Server::Servant_Upcall* servant_upcall) = 0;
/// Please see documentation in tao/Abstract_Servant_Base.h for
/// details.
virtual int _find (const char *opname,
TAO_Skeleton &skelfunc,
const size_t length = 0);
virtual int _find (const char *opname,
TAO_Collocated_Skeleton &skelfunc,
TAO::Collocation_Strategy st,
const size_t length = 0);
/// Get this interface's repository id (TAO specific).
virtual const char *_interface_repository_id (void) const = 0;
//@{
/**
* @name Reference Counting Operations
*/
/// Increase reference count by one.
virtual void _add_ref (void);
/**
* Decreases reference count by one; if the resulting reference
* count equals zero, _remove_ref invokes delete on its this pointer
* in order to destroy the servant.
*/
virtual void _remove_ref (void);
/**
* Returns the current reference count value.
*/
virtual CORBA::ULong _refcount_value (void) const;
//@}
virtual void _collocated_dispatch (::CORBA::Object_ptr obj,
::CORBA::Object_out forward_obj,
bool &is_forwarded,
TAO::Argument ** args,
int num_args,
const char * op,
size_t op_len,
TAO::Collocation_Strategy strategy);
protected:
/// Default constructor, only derived classes can be created.
TAO_ServantBase (void);
/// Copy constructor, protected so no instances can be created.
TAO_ServantBase (const TAO_ServantBase &);
/// Assignment operator.
TAO_ServantBase &operator= (const TAO_ServantBase &);
void synchronous_upcall_dispatch (
TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *derived_this);
void asynchronous_upcall_dispatch (
TAO_ServerRequest & req,
TAO::Portable_Server::Servant_Upcall* servant_upcall,
TAO_ServantBase *derived_this);
protected:
/// Reference counter.
ACE_Atomic_Op<TAO_SYNCH_MUTEX, unsigned long> ref_count_;
/// The operation table for this servant. It is initialized by the
/// most derived class.
TAO_Operation_Table * optable_;
};
class TAO_PortableServer_Export TAO_Servant_Hash
{
public:
/// Returns hash value.
u_long operator () (PortableServer::Servant servant) const;
};
namespace PortableServer
{
typedef Servant_var<TAO_ServantBase> ServantBase_var;
}
TAO_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
# include "tao/PortableServer/Servant_Base.inl"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* TAO_SERVANT_BASE_H */
|
