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
|
// -*- C++ -*-
//=============================================================================
/**
* @file Queued_Message.h
*
* $Id$
*
* @author Carlos O'Ryan <coryan@uci.edu>
*/
//=============================================================================
#ifndef TAO_QUEUED_MESSAGE_H
#define TAO_QUEUED_MESSAGE_H
#include /**/ "ace/pre.h"
#include "tao/LF_Invocation_Event.h"
#include "ace/os_include/os_stddef.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
struct iovec;
class ACE_Message_Block;
class ACE_Allocator;
/**
* @class TAO_Queued_Message
*
* @brief Represent messages queued in the outgoing data path of the
* TAO_Transport class.
*
* Please read the documentation in the TAO_Transport class to find
* out more about the design of the outgoing data path.
*
* In some configurations TAO needs to maintain a per-connection queue
* of outgoing messages. This queue is drained by the pluggable
* protocols framework, normally under control of the ACE_Reactor, but
* other configurations are conceivable. The elements in the queue
* may be removed early, for example, because the application can
* specify timeouts for each message, or because the underlying
* connection is broken.
*
* In many cases the message corresponds to some application request,
* the application may be blocked waiting for the request to be sent,
* even more importantlyl, the ORB can be configured to use the
* Leader/Followers strategy, in which case one of the waiting threads
* can be required to wake up before its message completes
* each message may contain a 'Sent_Notifier'
*
* <H4>NOTE:</H4> The contents of the ACE_Message_Block may have been
* allocated from TSS storage, in that case we cannot steal them.
* However, we do not need to perform a deep copy all the time, for
* example, in a twoway request the sending thread blocks until the
* data goes out. The queued message can borrow the memory as it will
* be deallocated by the sending thread when it finishes.
* Oneways and asynchronous calls are another story.
*
* @todo Change the ORB to allocate oneway and AMI buffer from global
* memory, to avoid the data copy in this path. What happens
* if the there is no queueing? Can we check that before
* allocating the memory?
*
*/
class TAO_Export TAO_Queued_Message : public TAO_LF_Invocation_Event
{
public:
/// Constructor
TAO_Queued_Message (ACE_Allocator *alloc = 0,
int is_heap_allocated = 0);
/// Destructor
virtual ~TAO_Queued_Message (void);
/** @name Intrusive list manipulation
*
* The messages are put in a doubled linked list (for easy insertion
* and removal). To minimize memory allocations the list is
* intrusive, i.e. each element in the list contains the pointers
* for the next and previous element.
*
* The following methods are used to manipulate this implicit list.
*
* @todo We should implement this as a base template, something
* like:<BR>
* template<class T> Intrusive_Node {<BR>
* public:<BR><BR>
* void next (T *);<BR>
* T* next () const;<BR><BR>
* private:<BR>
* T* next_;<BR>
* };<BR>
* and use it as follows:<BR>
* class TAO_Queued_Message : public Intrusive_Node<TAO_Queued_Message><BR>
* {<BR>
* };<BR>
*
*/
//@{
/// Set/get the next element in the list
virtual TAO_Queued_Message *next (void) const;
/// Set/get the previous element in the list
virtual TAO_Queued_Message *prev (void) const;
/// Remove this element from the list
virtual void remove_from_list (TAO_Queued_Message *&head,
TAO_Queued_Message *&tail);
/// Insert the current element at the tail of the queue.
virtual void push_back (TAO_Queued_Message *&head,
TAO_Queued_Message *&tail);
/// Insert the current element at the head of the queue.
virtual void push_front (TAO_Queued_Message *&head,
TAO_Queued_Message *&tail);
//@}
/** @name Template Methods
*/
//@{
/// Return the length of the message
/**
* If the message has been partially sent it returns the number of
* bytes that are still not sent.
*/
virtual size_t message_length (void) const = 0;
/// Return 1 if all the data has been sent
virtual int all_data_sent (void) const = 0;
/// Fill up an io vector using the connects of the message
/**
* Different versions of this class represent the message using
* either a single buffer, or a message block.
* This method allows a derived class to fill up the contents of an
* io vector, the TAO_Transport class uses this method to group as
* many messages as possible in an iovector before sending them to
* the OS I/O subsystem.
*
* @param iovcnt_max The number of elements in iov
* @param iovcnt The number of elements already used by iov, this
* method should update this counter
* @param iov The io vector
*/
virtual void fill_iov (int iovcnt_max,
int &iovcnt,
iovec iov[]) const = 0;
/// Update the internal state, data has been sent.
/**
* After the TAO_Transport class completes a successful (or
* partially successful) I/O operation it must update the state of
* all the messages queued. This callback method is used by each
* message to update its state and determine if all the data has
* been sent already.
*
* @param byte_count The number of bytes succesfully sent. The
* TAO_Queued_Message should decrement this value
* by the number of bytes that must still be sent.
* @return Returns 1 if the TAO_Queued_Message has any more data to
* send.
*/
virtual void bytes_transferred (size_t &byte_count) = 0;
/// Clone this element
/*
* Clone the element and return a pointer to the cloned element on
* the heap.
*
* @param allocator Use the allocator for creating the new element
* on the heap. Remember, that the allocator will
* not be used allocate the data contained in this
* element.
*/
virtual TAO_Queued_Message *clone (ACE_Allocator *allocator) = 0;
/// Reclaim resources
/**
* Reliable messages are allocated from the stack, thus they do not
* be deallocated.
* Asynchronous (SYNC_NONE) messages are allocated from the heap (or
* a pool), they need to be reclaimed explicitly.
*/
virtual void destroy (void) = 0;
//@}
protected:
/*
* Allocator that was used to create @c this object on the heap. If the
* allocator is null then @a this is on stack.
*/
ACE_Allocator *allocator_;
/*
* A flag that acts as a boolean to indicate whether @a this is on
* stack or heap. A non-zero value indicates that @a this was created
* on heap.
*/
int is_heap_created_;
private:
/// Implement an intrusive double-linked list for the message queue
TAO_Queued_Message *next_;
TAO_Queued_Message *prev_;
};
#include /**/ "ace/post.h"
#endif /* TAO_QUEUED_MESSAGE_H */
|
