blob: 1d61822a2b03ee3de01252eb4407e1d035da7497 (
plain)
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
|
// -*- C++ -*-
//=============================================================================
/**
* @file GIOP_Message_State.h
*
* $Id$
*
* GIOP utility definitions
*
*
* @author Chris Cleeland <cleeland@cs.wustl.edu>
* @author Carlos O' Ryan <coryan@uci.edu>
* @author modified by Balachandran Natarajan <bala@cs.wustl.edu>
*/
//=============================================================================
#ifndef TAO_GIOP_MESSAGE_STATE_H
#define TAO_GIOP_MESSAGE_STATE_H
#include "ace/pre.h"
#include "tao/GIOP_Message_Version.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
/**
* @class TAO_GIOP_Message_State
*
* @brief Generic definitions for Message States.
*
* @@Bala: More documentation please...
*
* This represents the state of the incoming GIOP message
* As the ORB processes incoming messages it needs to keep track of
* how much of the message has been read, if there are any
* fragments following this message etc.
*/
class TAO_Export TAO_GIOP_Message_State
{
public:
friend class TAO_GIOP_Message_Base;
enum TAO_GIOP_Message_Status
{
/// The header of the message hasn't shown up yet.
TAO_GIOP_WAITING_FOR_HEADER = 0,
/// The payload hasn't fully shown up in the yet
TAO_GIOP_WAITING_FOR_PAYLOAD,
/// The message read has got multiple requests
TAO_GIOP_MULTIPLE_MESSAGES
};
/// @@Bala: Documentation please...
/// Parse the message header.
int parse_message_header (ACE_Message_Block &incoming);
/// Return the message size
CORBA::ULong message_size (void) const;
/// Return the message size
CORBA::ULong payload_size (void) const;
/// Return the byte order information
CORBA::Octet byte_order (void) const;
private:
/// Ctor
TAO_GIOP_Message_State (TAO_ORB_Core *orb_core,
TAO_GIOP_Message_Base *base);
/// @@Bala: Documentation please...
int parse_message_header_i (ACE_Message_Block &incoming);
/// Checks for the magic word 'GIOP' in the start of the incoing
/// stream
int parse_magic_bytes (char *buf);
/// Extracts the version information from the incoming
/// stream. Performs a check for whether the version information is
/// right and sets the information in the <state>
int get_version_info (char *buf);
/// Extracts the byte order information from the incoming
/// stream. Performs a check for whether the byte order information
/// right and sets the information in the <state>
int get_byte_order_info (char *buf);
/// Gets the size of the payload and set the size in the <state>
void get_payload_size (char *buf);
/// Parses the GIOP FRAGMENT_HEADER information from the incoming
/// stream.
int parse_fragment_header (char *buf,
size_t length);
/// Read the unsigned long from the buffer. The <buf> should just
/// point to the next 4 bytes data that represent the ULong
CORBA::ULong read_ulong (char *buf);
private:
/// Version info
TAO_GIOP_Message_Version giop_version_;
/// 0 = big, 1 = little
CORBA::Octet byte_order_;
/// MsgType above
CORBA::Octet message_type_;
/// in byte_order!
CORBA::ULong message_size_;
/// Request Id from the Fragment header
CORBA::ULong request_id_;
/// (Requests and Replys)
CORBA::Octet more_fragments_;
/// Missing data
CORBA::ULong missing_data_;
/// @@Bala: Documentation??
TAO_GIOP_Message_Status message_status_;
};
const size_t TAO_GIOP_MESSAGE_HEADER_LEN = 12;
const size_t TAO_GIOP_MESSAGE_SIZE_OFFSET = 8;
const size_t TAO_GIOP_MESSAGE_FLAGS_OFFSET = 6;
const size_t TAO_GIOP_MESSAGE_TYPE_OFFSET = 7;
const size_t TAO_GIOP_VERSION_MINOR_OFFSET = 5;
const size_t TAO_GIOP_VERSION_MAJOR_OFFSET = 4;
const size_t TAO_GIOP_MESSAGE_FRAGMENT_HEADER = 4;
#if defined (__ACE_INLINE__)
# include "tao/GIOP_Message_State.inl"
#endif /* __ACE_INLINE__ */
#include "ace/post.h"
#endif /*TAO_GIOP_MESSAGE_STATE_H*/
|
