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
|
// This may look like C, but it's really -*- C++ -*-
//=============================================================================
/**
* @file Pluggable.h
*
* $Id$
*
* Interface for the TAO pluggable protocol framework.
*
*
* @author Fred Kuhns <fredk@cs.wustl.edu>
*/
//=============================================================================
#ifndef TAO_PLUGGABLE_H
#define TAO_PLUGGABLE_H
#include "ace/pre.h"
#include "tao/corbafwd.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "tao/Sequence.h"
#include "tao/Typecode.h"
#include "tao/IOPC.h"
// Forward declarations.
class ACE_Addr;
class ACE_Reactor;
class TAO_ORB_Core;
class TAO_Stub;
class TAO_Endpoint;
class TAO_Profile;
class TAO_MProfile;
class TAO_Resource_Factory;
class TAO_Reply_Dispatcher;
class TAO_Transport_Mux_Strategy;
class TAO_Wait_Strategy;
class TAO_GIOP_Invocation;
class TAO_Pluggable_Messaging_Interface;
class TAO_Target_Specification;
class TAO_Operation_Details;
class TAO_Transport_Descriptor_Interface;
class TAO_Transport;
// ****************************************************************
/**
* @class TAO_Acceptor
*
* @brief Abstract Acceptor class used for pluggable protocols.
*
* Base class for the Acceptor bridge class.
*/
class TAO_Export TAO_Acceptor
{
public:
TAO_Acceptor (CORBA::ULong tag);
/// Destructor
virtual ~TAO_Acceptor (void);
/// The tag, each concrete class will have a specific tag value.
CORBA::ULong tag (void) const;
/// The priority for this endpoint.
CORBA::Short priority (void) const;
/// Method to initialize acceptor for address.
virtual int open (TAO_ORB_Core *orb_core,
int version_major,
int version_minor,
const char *address,
const char *options = 0) = 0;
/**
* Open an acceptor with the given protocol version on a default
* endpoint
* @@ This method should be pure virtual, but in order to maintain
* some form of backward compatibilty, a default implementation
* is provided. Ideally, that default implementation should be
* removed in the near future.
*/
virtual int open_default (TAO_ORB_Core *,
int version_major,
int version_minor,
const char *options = 0) = 0;
/// Closes the acceptor
virtual int close (void) = 0;
/** Create the corresponding profile for this endpoint.
* If share_profile is set to true, the pluggable protocol
* implementation should try to add the endpoint to a profile
* in the mprofile that is of the same type. Currently, this
* is used when RT CORBA is enabled.
*/
virtual int create_mprofile (const TAO_ObjectKey &object_key,
TAO_MProfile &mprofile,
CORBA::Boolean share_profile) = 0;
/// Return 1 if the <endpoint> has the same address as the acceptor.
virtual int is_collocated (const TAO_Endpoint* endpoint) = 0;
/**
* Returns the number of endpoints this acceptor is listening on. This
* is used for determining how many profiles will be generated
* for this acceptor.
*/
virtual CORBA::ULong endpoint_count (void) = 0;
/**
* This method fetches the <key> from the <profile>. Protocols that
* are pluggable can send data that are specific in the
* <profile_data> field encapsulated as a octet stream. This method
* allows those protocols to get the object key from the
* encapsulation.
*/
virtual int object_key (IOP::TaggedProfile &profile,
TAO_ObjectKey &key) = 0;
protected:
/// The priority for this endpoint
CORBA::Short priority_;
private:
/// IOP protocol tag.
CORBA::ULong tag_;
};
/**
* @class TAO_Connector
*
* @brief Generic Connector interface definitions.
*
* Base class for connector bridge object.
*/
class TAO_Export TAO_Connector
{
public:
/// default constructor.
TAO_Connector (CORBA::ULong tag);
/// the destructor.
virtual ~TAO_Connector (void);
/**
* The tag identifying the specific ORB transport layer protocol.
* For example TAO_TAG_IIOP_PROFILE = 0. The tag is used in the
* IOR to identify the type of profile included. IOR -> {{tag0,
* profile0} {tag1, profole1} ...} GIOP.h defines typedef
* CORBA::ULong TAO_IOP_Profile_ID;
*/
CORBA::ULong tag (void) const;
/// Parse a string containing a URL style IOR and return an
/// MProfile.
int make_mprofile (const char *ior,
TAO_MProfile &mprofile,
CORBA::Environment &ACE_TRY_ENV);
/// Initialize object and register with reactor.
virtual int open (TAO_ORB_Core *orb_core) = 0;
/// Shutdown Connector bridge and concrete Connector.
virtual int close (void) = 0;
/**
* To support pluggable we need to abstract away the connect()
* method so it can be called from the GIOP code independant of the
* actual transport protocol in use.
*/
virtual int connect (TAO_GIOP_Invocation *invocation,
TAO_Transport_Descriptor_Interface *desc,
CORBA::Environment &ACE_TRY_ENV) = 0;
/// Initial set of connections to be established.
virtual int preconnect (const char *preconnections) = 0;
/// Create a profile for this protocol and initialize it based on the
/// encapsulation in <cdr>
virtual TAO_Profile *create_profile (TAO_InputCDR& cdr) = 0;
/// Check that the prefix of the provided endpoint is valid for use
/// with a given pluggable protocol.
virtual int check_prefix (const char *endpoint) = 0;
/// Return the object key delimiter to use or expect.
virtual char object_key_delimiter (void) const = 0;
protected:
/// Create a profile with a given endpoint.
virtual TAO_Profile *make_profile (CORBA::Environment &ACE_TRY_ENV) = 0;
/// Set the ORB Core pointer
void orb_core (TAO_ORB_Core *orb_core);
/// Return the TAO_ORB_Core pointer
TAO_ORB_Core *orb_core (void);
private:
/// IOP protocol tag.
CORBA::ULong tag_;
/// Pointer to our ORB core
TAO_ORB_Core *orb_core_;
};
#if defined (__ACE_INLINE__)
# include "tao/Pluggable.i"
#endif /* __ACE_INLINE__ */
#include "ace/post.h"
#endif /* TAO_PLUGGABLE_H */
|
