-
Notifications
You must be signed in to change notification settings - Fork 149
/
XrdClFile.hh
382 lines (349 loc) · 18.7 KB
/
XrdClFile.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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
//------------------------------------------------------------------------------
// 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_FILE_HH__
#define __XRD_CL_FILE_HH__
#include "XrdCl/XrdClFileSystem.hh"
#include "XrdCl/XrdClXRootDResponses.hh"
#include <stdint.h>
#include <string>
#include <vector>
namespace XrdCl
{
class FileStateHandler;
class FilePlugIn;
//----------------------------------------------------------------------------
//! A file
//----------------------------------------------------------------------------
class File
{
public:
//------------------------------------------------------------------------
//! Constructor
//------------------------------------------------------------------------
File( bool enablePlugIns = true );
//------------------------------------------------------------------------
//! Destructor
//------------------------------------------------------------------------
virtual ~File();
//------------------------------------------------------------------------
//! Open the file pointed to by the given URL - async
//!
//! @param url url of the file to be opened
//! @param flags OpenFlags::Flags
//! @param mode Access::Mode for new files, 0 otherwise
//! @param handler handler to be notified about the status of the operation
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Open( const std::string &url,
OpenFlags::Flags flags,
Access::Mode mode,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Open the file pointed to by the given URL - sync
//!
//! @param url url of the file to be opened
//! @param flags OpenFlags::Flags
//! @param mode Access::Mode for new files, 0 otherwise
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Open( const std::string &url,
OpenFlags::Flags flags,
Access::Mode mode = Access::None,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Close the file - async
//!
//! @param handler handler to be notified about the status of the operation
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Close( ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Close the file - sync
//!
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Close( uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Obtain status information for this file - async
//!
//! @param force do not use the cached information, force re-stating
//! @param handler handler to be notified when the response arrives,
//! the response parameter will hold a StatInfo object
//! if the procedure is successful
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Stat( bool force,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Obtain status information for this file - sync
//!
//! @param force do not use the cached information, force re-stating
//! @param response the response (to be deleted by the user)
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Stat( bool force,
StatInfo *&response,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Read a data chunk at a given offset - async
//!
//! @param offset offset from the beginning of the file
//! @param size number of bytes to be read
//! @param buffer a pointer to a buffer big enough to hold the data
//! or 0 if the buffer should be allocated by the system
//! @param handler handler to be notified when the response arrives,
//! the response parameter will hold a ChunkInfo object if
//! the procedure was successful
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Read( uint64_t offset,
uint32_t size,
void *buffer,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Read a data chunk at a given offset - sync
//!
//! @param offset offset from the beginning of the file
//! @param size number of bytes to be read
//! @param buffer a pointer to a buffer big enough to hold the data
//! @param bytesRead number of bytes actually read
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Read( uint64_t offset,
uint32_t size,
void *buffer,
uint32_t &bytesRead,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Write a data chunk at a given offset - async
//! The call interprets and returns the server response, which may be
//! either a success or a failure, it does not contain the number
//! of bytes that were actually written.
//!
//! @param offset offset from the beginning of the file
//! @param size number of bytes to be written
//! @param buffer a pointer to the buffer holding the data to be written
//! @param handler handler to be notified when the response arrives
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Write( uint64_t offset,
uint32_t size,
const void *buffer,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Write a data chunk at a given offset - sync
//! The call interprets and returns the server response, which may be
//! either a success or a failure, it does not contain the number
//! of bytes that were actually written.
//!
//! @param offset offset from the beginning of the file
//! @param size number of bytes to be written
//! @param buffer a pointer to the buffer holding the data to be
//! written
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Write( uint64_t offset,
uint32_t size,
const void *buffer,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Commit all pending disk writes - async
//!
//! @param handler handler to be notified when the response arrives
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Sync( ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Commit all pending disk writes - sync
//!
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Sync( uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Truncate the file to a particular size - async
//!
//! @param size desired size of the file
//! @param handler handler to be notified when the response arrives
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Truncate( uint64_t size,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Truncate the file to a particular size - sync
//!
//! @param size desired size of the file
//! @param timeout timeout value, if 0 the environment default will be
//! used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Truncate( uint64_t size, uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Read scattered data chunks in one operation - async
//!
//! @param chunks list of the chunks to be read and buffers to put
//! the data in. The default maximum chunk size is
//! 2097136 bytes and the default maximum number
//! of chunks per request is 1024. The server
//! may be queried using FileSystem::Query for the
//! actual settings.
//! @param buffer if zero the buffer pointers in the chunk list
//! will be used, otherwise it needs to point to a
//! buffer big enough to hold the requested data
//! @param handler handler to be notified when the response arrives
//! @param timeout timeout value, if 0 then the environment default
//! will be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus VectorRead( const ChunkList &chunks,
void *buffer,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Read scattered data chunks in one operation - sync
//!
//! @param chunks list of the chunks to be read and buffers to put
//! the data in. The default maximum chunk size is
//! 2097136 bytes and the default maximum number
//! of chunks per request is 1024. The server
//! may be queried using FileSystem::Query for the
//! actual settings.
//! @param buffer if zero the buffer pointers in the chunk list
//! will be used, otherwise it needs to point to a
//! buffer big enough to hold the requested data
//! @param vReadInfo buffer size and chunk information
//! @param timeout timeout value, if 0 then the environment default
//! will be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus VectorRead( const ChunkList &chunks,
void *buffer,
VectorReadInfo *&vReadInfo,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Performs a custom operation on an open file, server implementation
//! dependent - async
//!
//! @param arg query argument
//! @param handler handler to be notified when the response arrives,
//! the response parameter will hold a Buffer object
//! if the procedure is successful
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Fcntl( const Buffer &arg,
ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Performs a custom operation on an open file, server implementation
//! dependent - sync
//!
//! @param arg query argument
//! @param response the response (to be deleted by the user)
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Fcntl( const Buffer &arg,
Buffer *&response,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Get access token to a file - async
//!
//! @param handler handler to be notified when the response arrives,
//! the response parameter will hold a Buffer object
//! if the procedure is successful
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Visa( ResponseHandler *handler,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Get access token to a file - sync
//!
//! @param visa the access token (to be deleted by the user)
//! @param timeout timeout value, if 0 the environment default will
//! be used
//! @return status of the operation
//------------------------------------------------------------------------
XRootDStatus Visa( Buffer *&visa,
uint16_t timeout = 0 );
//------------------------------------------------------------------------
//! Check if the file is open
//------------------------------------------------------------------------
bool IsOpen() const;
//------------------------------------------------------------------------
//! Set file property
//!
//! File properties:
//! ReadRecovery [true/false] - enable/disable read recovery
//! WriteRecovery [true/false] - enable/disable write recovery
//! FollowRedirects [true/false] - enable/disable following redirections
//------------------------------------------------------------------------
bool SetProperty( const std::string &name, const std::string &value );
//------------------------------------------------------------------------
//! Get file property
//!
//! @see File::SetProperty for property list
//!
//! Read-only properties:
//! DataServer [string] - the data server the file is accessed at
//! LastURL [string] - final file URL with all the cgi information
//------------------------------------------------------------------------
bool GetProperty( const std::string &name, std::string &value ) const;
private:
FileStateHandler *pStateHandler;
FilePlugIn *pPlugIn;
bool pEnablePlugIns;
};
}
#endif // __XRD_CL_FILE_HH__