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
|
// This may look like C, but it's really -*- C++ -*-
// $Id$
// ============================================================================
//
// = LIBRARY
// TAO
//
// = FILENAME
// SHMIOP_Profile.h
//
// = DESCRIPTION
// SHMIOP profile specific processing
//
// = AUTHOR
// Nanbor Wang <nanbor@cs.wustl.edu>
//
// ============================================================================
#ifndef TAO_SHMIOP_PROFILE_H
#define TAO_SHMIOP_PROFILE_H
#include "ace/pre.h"
#include "tao/corbafwd.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#if defined (TAO_HAS_SHMIOP) && (TAO_HAS_SHMIOP != 0)
#include "strategies_export.h"
#include "tao/Profile.h"
#include "tao/Object_KeyC.h"
#include "SHMIOP_Endpoint.h"
#include "ace/Synch.h"
// TAO SHMIOP_Profile concrete Profile definitions
class TAO_Strategies_Export TAO_SHMIOP_Profile : public TAO_Profile
{
// = TITLE
// This class defines the protocol specific attributes required
// for locating local ORBs over local IPC mechanism to use the
// shared memory transport.
// = DESCRIPTION
// This class defines the SHMIOP profile.
public:
static const char object_key_delimiter_;
virtual char object_key_delimiter (void) const;
// The object key delimiter that SHMIOP uses or expects.
static const char *prefix (void);
// Return the char string prefix.
TAO_SHMIOP_Profile (const ACE_MEM_Addr &addr,
const TAO_ObjectKey &object_key,
const TAO_GIOP_Version &version,
TAO_ORB_Core *orb_core);
// Profile constructor, same as above except the object_key has
// already been marshaled.
TAO_SHMIOP_Profile (const char *host,
CORBA::UShort port,
const TAO_ObjectKey &object_key,
const ACE_INET_Addr &addr,
const TAO_GIOP_Version &version,
TAO_ORB_Core *orb_core);
// Profile constructor, this is the most efficient since it
// doesn't require any address resolution processing.
TAO_SHMIOP_Profile (const char *string,
TAO_ORB_Core *orb_core,
CORBA::Environment &ACE_TRY_ENV = TAO_default_environment ());
// Create object using a string ior.
TAO_SHMIOP_Profile (TAO_ORB_Core *orb_core);
// Profile constructor, default.
~TAO_SHMIOP_Profile (void);
// Destructor is to be called only through <_decr_refcnt>.
int parse_string (const char *string,
CORBA::Environment &ACE_TRY_ENV =
TAO_default_environment ());
// Initialize this object using the given input string.
char * to_string (CORBA::Environment &ACE_TRY_ENV =
TAO_default_environment ());
// Return a string representation for this profile.
// client must deallocate memory.
int decode (TAO_InputCDR& cdr);
// Initialize this object using the given CDR octet string.
virtual int encode (TAO_OutputCDR &stream) const;
// Encode this profile in a stream, i.e. marshal it.
virtual int encode_endpoints (void);
// Encodes this profile's endpoints into a tagged component.
// This is done only if RTCORBA is enabled, since currently this is
// the only case when we have more than one endpoint per profile.
// Return 0 on success, -1 on failure.
//
// Endpoints are transmitted using TAO-proprietory tagged component.
// Component tag is TAO_TAG_ENDPOINTS and component data is an
// encapsulation of a sequence of structs, each representing a
// single endpoint. Data format is specified in iiop_endpoins.pidl.
//
// Multiple a la TAG_ALTERNATE_IIOP_ADDRESS components can be used
// instead of a single proprietory component to transmit multiple
// endpoints. This is somewhat slower and less convenient. Also,
// TAG_ALTERNATE_IIOP_ADDRESS does not provide for transmission of
// endpoint priorities.
//
virtual const TAO_ObjectKey &object_key (void) const;
// @@ deprecated. return a reference to the Object Key.
TAO_ObjectKey *_key (void) const;
// Return a pointer to the Object Key. The caller owns the memory
// allocated for the returned key.
virtual TAO_Endpoint *endpoint (void);
// Return pointer to the head of this profile's endpoints list.
virtual size_t endpoint_count (void);
// Return how many endpoints this profile contains.
void add_endpoint (TAO_SHMIOP_Endpoint *endp);
// Add <endp> to this profile's list of endpoints (it is inserted
// next to the head of the list). This profiles takes ownership of
// <endp>.
CORBA::Boolean is_equivalent (const TAO_Profile *other_profile);
// Return true if this profile is equivalent to other_profile. Two
// profiles are equivalent iff their tag, object_key, version and
// all endpoints are the same.
CORBA::ULong hash (CORBA::ULong max,
CORBA::Environment &ACE_TRY_ENV =
TAO_default_environment ());
// Return a hash value for this object.
IOP::TaggedProfile &create_tagged_profile (void);
// Please refer to Profile.h for the documentation of this method
private:
void create_profile_body (TAO_OutputCDR &cdr) const;
// Create an encapsulation of the struct ProfileBody in <cdr>
int decode_endpoints (void);
// Helper for <decode>. Decodes endpoints from a tagged component.
// Decode only if RTCORBA is enabled. Furthermore, we may not find
// TAO_TAG_ENDPOINTS component, e.g., if we are talking to nonRT
// version of TAO or some other ORB. This is not an error, and we
// must proceed. Return 0 on success and -1 on failure.
TAO_SHMIOP_Endpoint endpoint_;
// Head of this profile's list of endpoints. This endpoint is not
// dynamically allocated because a profile always contains at least
// one endpoint.
//
// Currently, a profile contains more than one endpoint, i.e.,
// list contains more than just the head, only when RTCORBA is enabled.
// However, in the near future, this will be used in nonRT
// mode as well, e.g., to support TAG_ALTERNATE_IIOP_ADDRESS-style
// feature.
// Addressing info of the default endpoint, i.e., head of the list,
// is transmitted using standard SHMIOP ProfileBody components. See
// <encode_endpoints> method documentation above for how the rest of
// the endpoint list is transmitted.
size_t count_;
// Number of endpoints in the list headed by <endpoint_>.
TAO_ObjectKey object_key_;
// object_key associated with this profile.
IOP::TaggedProfile tagged_profile_;
// The tagged profile info
};
#if defined (__ACE_INLINE__)
# include "SHMIOP_Profile.i"
#endif /* __ACE_INLINE__ */
#endif /* TAO_HAS_SHMIOP && TAO_HAS_SHMIOP != 0 */
#include "ace/post.h"
#endif /* TAO_SHMIOP_PROFILE_H */
|
