-
Notifications
You must be signed in to change notification settings - Fork 149
/
XrdClStream.hh
362 lines (315 loc) · 15.1 KB
/
XrdClStream.hh
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD. If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
#ifndef __XRD_CL_STREAM_HH__
#define __XRD_CL_STREAM_HH__
#include "XrdCl/XrdClPoller.hh"
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClPostMasterInterfaces.hh"
#include "XrdCl/XrdClChannelHandlerList.hh"
#include "XrdCl/XrdClJobManager.hh"
#include "XrdCl/XrdClInQueue.hh"
#include "XrdCl/XrdClUtils.hh"
#include "XrdSys/XrdSysPthread.hh"
#include "XrdNet/XrdNetAddr.hh"
#include <list>
#include <vector>
#include <functional>
namespace XrdCl
{
class Message;
class Channel;
class TransportHandler;
class TaskManager;
struct SubStreamData;
//----------------------------------------------------------------------------
//! Stream
//----------------------------------------------------------------------------
class Stream
{
public:
//------------------------------------------------------------------------
//! Status of the stream
//------------------------------------------------------------------------
enum StreamStatus
{
Disconnected = 0, //!< Not connected
Connected = 1, //!< Connected
Connecting = 2, //!< In the process of being connected
Error = 3 //!< Broken
};
//------------------------------------------------------------------------
//! Constructor
//------------------------------------------------------------------------
Stream( const URL *url );
//------------------------------------------------------------------------
//! Destructor
//------------------------------------------------------------------------
~Stream();
//------------------------------------------------------------------------
//! Initializer
//------------------------------------------------------------------------
Status Initialize();
//------------------------------------------------------------------------
//! Queue the message for sending
//------------------------------------------------------------------------
Status Send( Message *msg,
OutgoingMsgHandler *handler,
bool stateful,
time_t expires );
//------------------------------------------------------------------------
//! Set the transport
//------------------------------------------------------------------------
void SetTransport( TransportHandler *transport )
{
pTransport = transport;
}
//------------------------------------------------------------------------
//! Set the poller
//------------------------------------------------------------------------
void SetPoller( Poller *poller )
{
pPoller = poller;
}
//------------------------------------------------------------------------
//! Set the incoming queue
//------------------------------------------------------------------------
void SetIncomingQueue( InQueue *incomingQueue )
{
pIncomingQueue = incomingQueue;
delete pQueueIncMsgJob;
pQueueIncMsgJob = new QueueIncMsgJob( incomingQueue );
}
//------------------------------------------------------------------------
//! Set the channel data
//------------------------------------------------------------------------
void SetChannelData( AnyObject *channelData )
{
pChannelData = channelData;
}
//------------------------------------------------------------------------
//! Set task manager
//------------------------------------------------------------------------
void SetTaskManager( TaskManager *taskManager )
{
pTaskManager = taskManager;
}
//------------------------------------------------------------------------
//! Set job manager
//------------------------------------------------------------------------
void SetJobManager( JobManager *jobManager )
{
pJobManager = jobManager;
}
//------------------------------------------------------------------------
//! Connect if needed, otherwise make sure that the underlying socket
//! handler gets write readiness events, it will update the path with
//! what it has actually enabled
//------------------------------------------------------------------------
Status EnableLink( PathID &path );
//------------------------------------------------------------------------
//! Disconnect the stream
//------------------------------------------------------------------------
void Disconnect( bool force = false );
//------------------------------------------------------------------------
//! Handle a clock event generated either by socket timeout, or by
//! the task manager event
//------------------------------------------------------------------------
void Tick( time_t now );
//------------------------------------------------------------------------
//! Get the URL
//------------------------------------------------------------------------
const URL *GetURL() const
{
return pUrl;
}
//------------------------------------------------------------------------
//! Force connection
//------------------------------------------------------------------------
void ForceConnect();
//------------------------------------------------------------------------
//! Return stream name
//------------------------------------------------------------------------
const std::string &GetName() const
{
return pStreamName;
}
//------------------------------------------------------------------------
//! Disables respective uplink if empty
//------------------------------------------------------------------------
void DisableIfEmpty( uint16_t subStream );
//------------------------------------------------------------------------
//! Call back when a message has been reconstructed
//------------------------------------------------------------------------
void OnIncoming( uint16_t subStream,
Message *msg,
uint32_t bytesReceived );
//------------------------------------------------------------------------
// Call when one of the sockets is ready to accept a new message
//------------------------------------------------------------------------
std::pair<Message *, OutgoingMsgHandler *>
OnReadyToWrite( uint16_t subStream );
//------------------------------------------------------------------------
// Call when a message is written to the socket
//------------------------------------------------------------------------
void OnMessageSent( uint16_t subStream,
Message *msg,
uint32_t bytesSent );
//------------------------------------------------------------------------
//! Call back when a message has been reconstructed
//------------------------------------------------------------------------
void OnConnect( uint16_t subStream );
//------------------------------------------------------------------------
//! On connect error
//------------------------------------------------------------------------
void OnConnectError( uint16_t subStream, Status status );
//------------------------------------------------------------------------
//! On error
//------------------------------------------------------------------------
void OnError( uint16_t subStream, Status status );
//------------------------------------------------------------------------
//! Force error
//------------------------------------------------------------------------
void ForceError( Status status );
//------------------------------------------------------------------------
//! On read timeout
//------------------------------------------------------------------------
void OnReadTimeout( uint16_t subStream, bool &isBroken );
//------------------------------------------------------------------------
//! On write timeout
//------------------------------------------------------------------------
void OnWriteTimeout( uint16_t subStream );
//------------------------------------------------------------------------
//! Register channel event handler
//------------------------------------------------------------------------
void RegisterEventHandler( ChannelEventHandler *handler );
//------------------------------------------------------------------------
//! Remove a channel event handler
//------------------------------------------------------------------------
void RemoveEventHandler( ChannelEventHandler *handler );
//------------------------------------------------------------------------
//! Install a message handler for the given message if there is one
//! available, if the handler want's to be called in the raw mode
//! it will be returned, the message ownership flag is returned
//! in any case
//!
//! @param msg message header
//! @param stream stream concerned
//! @return a pair containing the handler and ownership flag
//------------------------------------------------------------------------
std::pair<IncomingMsgHandler *, bool>
InstallIncHandler( Message *msg, uint16_t stream );
//------------------------------------------------------------------------
//! Set the on-connect handler for data streams
//------------------------------------------------------------------------
void SetOnConnectHandler( Job *onConnJob )
{
delete pOnConnJob;
pOnConnJob = onConnJob;
}
private:
//------------------------------------------------------------------------
// Job queuing the incoming messages
//------------------------------------------------------------------------
class QueueIncMsgJob: public Job
{
public:
QueueIncMsgJob( InQueue *queue ): pQueue( queue ) {};
virtual ~QueueIncMsgJob() {};
virtual void Run( void *arg )
{
Message *msg = (Message *)arg;
pQueue->AddMessage( msg );
}
private:
InQueue *pQueue;
};
//------------------------------------------------------------------------
// Job handling the incoming messages
//------------------------------------------------------------------------
class HandleIncMsgJob: public Job
{
public:
HandleIncMsgJob( IncomingMsgHandler *handler ): pHandler( handler ) {};
virtual ~HandleIncMsgJob() {};
virtual void Run( void *arg )
{
Message *msg = (Message *)arg;
pHandler->Process( msg );
delete this;
}
private:
IncomingMsgHandler *pHandler;
};
//------------------------------------------------------------------------
//! On fatal error - unlocks the stream
//------------------------------------------------------------------------
void OnFatalError( uint16_t subStream,
Status status,
XrdSysMutexHelper &lock );
//------------------------------------------------------------------------
//! Inform the monitoring about disconnection
//------------------------------------------------------------------------
void MonitorDisconnection( Status status );
//------------------------------------------------------------------------
//! Send close after an open request timed out
//------------------------------------------------------------------------
Status RequestClose( Message *resp );
typedef std::vector<SubStreamData*> SubStreamList;
//------------------------------------------------------------------------
// Data members
//------------------------------------------------------------------------
const URL *pUrl;
std::string pStreamName;
TransportHandler *pTransport;
Poller *pPoller;
TaskManager *pTaskManager;
JobManager *pJobManager;
XrdSysRecMutex pMutex;
InQueue *pIncomingQueue;
AnyObject *pChannelData;
uint32_t pLastStreamError;
Status pLastFatalError;
uint16_t pStreamErrorWindow;
uint16_t pConnectionCount;
uint16_t pConnectionRetry;
time_t pConnectionInitTime;
uint16_t pConnectionWindow;
SubStreamList pSubStreams;
std::vector<XrdNetAddr> pAddresses;
Utils::AddressType pAddressType;
ChannelHandlerList pChannelEvHandlers;
uint64_t pSessionId;
//------------------------------------------------------------------------
// Jobs
//------------------------------------------------------------------------
QueueIncMsgJob *pQueueIncMsgJob;
//------------------------------------------------------------------------
// Monitoring info
//------------------------------------------------------------------------
timeval pConnectionStarted;
timeval pConnectionDone;
uint64_t pBytesSent;
uint64_t pBytesReceived;
//------------------------------------------------------------------------
// Data stream on-connect handler
//------------------------------------------------------------------------
Job *pOnConnJob;
};
}
#endif // __XRD_CL_STREAM_HH__