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
|
// -*- C++ -*-
//=============================================================================
/**
* @file UIOP_Profile.h
*
* $Id$
*
* Unix Domain Socket (UIOP) profile specific processing
*
*
* @author Ossama Othman <ossama@uci.edu>
* @author Fred Kuhns <fredk@cs.wustl.edu>
*/
//=============================================================================
#ifndef TAO_UIOP_PROFILE_H
#define TAO_UIOP_PROFILE_H
#include "ace/pre.h"
#include "tao/Profile.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
# if TAO_HAS_UIOP == 1
#include "strategies_export.h"
#include "tao/Object_KeyC.h"
#include "UIOP_Connection_Handler.h"
#include "UIOP_Endpoint.h"
#include "ace/UNIX_Addr.h"
#include "ace/Synch.h"
// TAO UIOP_Profile concrete Profile definitions
/**
* @class TAO_UIOP_Profile
*
* @brief This class defines the protocol specific attributes required
* for locating ORBs over local IPC.
*
* This class defines the UIOP profile.
*/
class TAO_Strategies_Export TAO_UIOP_Profile : public TAO_Profile
{
public:
/// The object key delimiter that UIOP uses or expects.
static const char object_key_delimiter_;
virtual char object_key_delimiter (void) const;
/// Return the char string prefix.
static const char *prefix (void);
/// Profile constructor, same as above except the object_key has
/// already been marshaled. (actually, no marshalling for this protocol)
TAO_UIOP_Profile (const ACE_UNIX_Addr &addr,
const TAO_ObjectKey &object_key,
const TAO_GIOP_Message_Version &version,
TAO_ORB_Core *orb_core);
/// Profile constructor
TAO_UIOP_Profile (const char *rendezvous_point,
const TAO_ObjectKey &object_key,
const ACE_UNIX_Addr &addr,
const TAO_GIOP_Message_Version &version,
TAO_ORB_Core *orb_core);
/// Profile constructor, default.
TAO_UIOP_Profile (TAO_ORB_Core *orb_core);
/// Destructor is to be called only through <_decr_refcnt>.
~TAO_UIOP_Profile (void);
/// Initialize this object using the given input string.
virtual void parse_string (const char *string
TAO_ENV_ARG_DECL);
/// Return a string representation for this profile.
/// client must deallocate memory.
virtual char * to_string (TAO_ENV_SINGLE_ARG_DECL);
/// Initialize this object using the given CDR octet string.
virtual int decode (TAO_InputCDR& cdr);
/// Encode this profile in a stream, i.e. marshal it.
virtual int encode (TAO_OutputCDR &stream) const;
/**
* 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 uiop_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 int encode_endpoints (void);
/// @@ deprecated. return a reference to the Object Key.
virtual const TAO_ObjectKey &object_key (void) const;
/// Return a pointer to the Object Key. The caller owns the memory
/// allocated for the returned key.
virtual TAO_ObjectKey *_key (void) const;
/// Return pointer to the head of this profile's endpoints list.
virtual TAO_Endpoint *endpoint (void);
/// Return how many endpoints this profile contains.
virtual size_t endpoint_count (void);
/**
* 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>.
*/
void add_endpoint (TAO_UIOP_Endpoint *endp);
/**
* 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.
*/
virtual CORBA::Boolean is_equivalent (const TAO_Profile *other_profile);
/// Return a hash value for this object.
virtual CORBA::ULong hash (CORBA::ULong max
TAO_ENV_ARG_DECL);
/// Please see the Profile.h for the documentation of this method
virtual IOP::TaggedProfile &create_tagged_profile (void);
private:
/// Create an encapsulation of the struct ProfileBody in <cdr>
void create_profile_body (TAO_OutputCDR &cdr) const;
/**
* 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.
*/
int decode_endpoints (void);
/**
* 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 a la TAG_ALTERNATE_IIOP_ADDRESS
* feature.
* Addressing info of the default endpoint, i.e., head of the list,
* is transmitted using standard UIOP ProfileBody components. See
* <encode_endpoints> method documentation above for how the rest of
* the endpoint list is transmitted.
*/
TAO_UIOP_Endpoint endpoint_;
/// Number of endpoints in the list headed by <endpoint_>.
size_t count_;
/// object_key associated with this profile.
TAO_ObjectKey object_key_;
/// Our tagged profile info
IOP::TaggedProfile tagged_profile_;
};
#if defined (__ACE_INLINE__)
# include "UIOP_Profile.i"
#endif /* __ACE_INLINE__ */
# endif /* TAO_HAS_UIOP == 1 */
#include "ace/post.h"
#endif /* TAO_UIOP_PROFILE_H */
|
