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
|
// -*- C++ -*-
// $Id$
// ============================================================================
//
// = LIBRARY
// TAO
//
// = FILENAME
// GIOP_Message_Lite.h
//
// = DESCRIPTION
// Interface for the GIOP Lite messaging protocol
//
// = AUTHOR
// Balachandran Natarajan <bala@cs.wustl.edu>
//
// ============================================================================
#ifndef TAO_GIOP_MESSAGE_LITE_H
#define TAO_GIOP_MESSAGE_LITE_H
#include "ace/pre.h"
#include "tao/CDR.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "tao/GIOP_Utils.h"
#include "tao/GIOP_Message_State.h"
#include "tao/ORB_Core.h"
class TAO_GIOP_ServerRequest;
class TAO_GIOP_Locate_Request_Header;
class TAO_Export TAO_GIOP_Message_Lite : public TAO_Pluggable_Messaging
{
// = TITLE
// Definitions got the GIOP lite
//
// = DESCRIPTION
// @@ Bala: please be precise when writing comments, and avoid
// colloquial expressions like 'quite a', you are writing
// technical documentation, not a novel...
// @@ Bala: wouldn't this be a better description of this class:
// Implement the GIOP lite pluggable messaging protocol. Very
// similar to the GIOP protocol, but several fields are removed to
// reduce overhead on homogenous systems.
//
// The interface is quite a replica of the GIOP Base
// interface. Implmenetation may not vary much too. But we are
// having a seperate interface to have seperation of concerns.
//
public:
TAO_GIOP_Message_Lite (TAO_ORB_Core *orb_core);
//Ctor
virtual ~TAO_GIOP_Message_Lite (void);
// Dtor
virtual CORBA::Boolean write_protocol_header (TAO_Pluggable_Message_Type t,
TAO_OutputCDR &msg);
// Writes the GIOPLite header in to <msg>
int handle_input (TAO_Transport *transport,
TAO_ORB_Core *orb_core,
TAO_Message_State_Factory &mesg_state,
ACE_Time_Value *max_time_value = 0);
// Reads input from the transport layer to the cdr stream in <mesg_state>
virtual CORBA::Boolean
write_message_header (const TAO_Operation_Details &opdetails,
TAO_Pluggable_Header_Type header_type,
TAO_Target_Specification &spec,
TAO_OutputCDR &msg);
// Write the header defined by <header_type> in to <msg>
int send_message (TAO_Transport *transport,
TAO_OutputCDR &stream,
ACE_Time_Value *max_wait_time = 0,
TAO_Stub *stub = 0,
int two_way = 1);
// Sends the encapsulated stream in <stream> on to the transport
int parse_reply (TAO_Message_State_Factory &mesg_state,
TAO_Pluggable_Reply_Params ¶ms);
// Parse the reply message from the server
int process_client_message (TAO_Transport *transport,
TAO_ORB_Core *orb_core,
TAO_InputCDR &input,
CORBA::Octet message_type);
// Processes the messages from the connectors so that they can be
// passed on to the appropriate states.
CORBA::Boolean write_reply_header (TAO_OutputCDR &cdr,
TAO_Pluggable_Reply_Params &reply,
CORBA::Environment &ACE_TRY_ENV =
TAO_default_environment ())
ACE_THROW_SPEC ((CORBA::SystemException));
private:
CORBA::Boolean
write_request_header (const TAO_Operation_Details &details,
TAO_Target_Specification &spec,
TAO_OutputCDR &msg);
// Write the GIOP lite request header in to <msg>
CORBA::Boolean
write_locate_request_header (CORBA::ULong request_id,
TAO_Target_Specification &spec,
TAO_OutputCDR &msg);
// Write the GIOP lite locate request header in to <msg>
int parse_header (TAO_GIOP_Message_State *state);
// Parse the header
int process_client_request (TAO_Transport *transport,
TAO_ORB_Core* orb_core,
TAO_InputCDR &input);
// A request was received on the server side. <transport> is the
// source of the message (and thus where the replies should be
// sent). <orb_core> is the ORB that received the message <input>
// contains the message <output> can be used to store any responses
// <request_id> and <response_required> are set as part of the
// message processing.
int process_client_locate (TAO_Transport *transport,
TAO_ORB_Core* orb_core,
TAO_InputCDR &input);
// A LocateRequest was received on the server side. <transport> is
// the source of the message (and thus where the replies should be
// sent). <orb_core> is the ORB that received the message <input>
// contains the message <output> can be used to store any responses
// <request_id> and <response_required> are set as part of the
// message processing.
void find_ior_in_table (TAO_ObjectKey &object_key,
TAO_ORB_Core *orb_core,
CORBA::Environment &ACE_TRY_ENV);
// Find the IOR in table
int parse_request_header (TAO_GIOP_ServerRequest &request);
// Parse the Request Message header
int parse_locate_header (TAO_GIOP_Locate_Request_Header &request);
// Parse the Locate Request header
int send_reply_exception (TAO_Transport *transport,
TAO_ORB_Core* orb_core,
CORBA::ULong request_id,
IOP::ServiceContextList *svc_info,
CORBA::Exception *x);
// We must send a LocateReply through <transport>, this request
// resulted in some kind of exception.
int make_locate_reply (TAO_Transport *transport,
TAO_OutputCDR & output,
TAO_GIOP_Locate_Request_Header &request,
TAO_GIOP_Locate_Status_Msg &status_info);
// Making replies for LocateRequest messages.
int send_error (TAO_Transport *transport);
// Send error messages
void dump_msg (const char *label,
const u_char *ptr,
size_t len);
// Print out the contents of the buffer.
ACE_Allocator *cdr_buffer_alloc_;
ACE_Allocator *cdr_dblock_alloc_;
// Allocators for the outpur CDR that we hold. As we cannot rely on
// the resources from ORB Core we reserve our own resources. The
// reason that we cannot believe the ORB core is that, for a
// multi-threaded servers it dishes out resources cached in
// TSS. This would be dangerous as TSS gets destroyed before we
// would. So we have our own memory that we can rely on.
TAO_OutputCDR *output_;
// The output cdr for the GIOP lite message
char repbuf_[ACE_CDR::DEFAULT_BUFSIZE];
// Char array to initialise our Output CDR class
};
// @@ Bala: Do you really need to define these in the header file?
// The IIOP Lite header length and the offset of the message size
// field in it.
const size_t TAO_GIOP_LITE_HEADER_LEN = 5;
const size_t TAO_GIOP_LITE_MESSAGE_SIZE_OFFSET = 0;
const size_t TAO_GIOP_LITE_MESSAGE_TYPE_OFFSET = 4;
#if defined (__ACE_INLINE__)
# include "tao/GIOP_Message_Lite.i"
#endif /* __ACE_INLINE__ */
#include "ace/post.h"
#endif /*TAO_GIOP_MESSAGE_LITE_H*/
|
