-
Notifications
You must be signed in to change notification settings - Fork 149
/
XrdClPlugInInterface.hh
568 lines (517 loc) · 26.1 KB
/
XrdClPlugInInterface.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
//------------------------------------------------------------------------------
// Copyright (c) 2014 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// This file is part of the XRootD software suite.
//
// 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/>.
//
// In applying this licence, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
//------------------------------------------------------------------------------
#ifndef __XRD_CL_PLUGIN_INTERFACE__
#define __XRD_CL_PLUGIN_INTERFACE__
#include "XrdCl/XrdClFile.hh"
#include "XrdCl/XrdClFileSystem.hh"
#include "XrdCl/XrdClOptional.hh"
namespace XrdCl
{
//----------------------------------------------------------------------------
//! An interface for file plug-ins
//----------------------------------------------------------------------------
class FilePlugIn
{
public:
//------------------------------------------------------------------------
//! Destructor
//------------------------------------------------------------------------
virtual ~FilePlugIn() {}
//------------------------------------------------------------------------
//! @see XrdCl::File::Open
//------------------------------------------------------------------------
virtual XRootDStatus Open( const std::string &url,
OpenFlags::Flags flags,
Access::Mode mode,
ResponseHandler *handler,
uint16_t timeout )
{
(void)url; (void)flags; (void)mode; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Close
//------------------------------------------------------------------------
virtual XRootDStatus Close( ResponseHandler *handler,
uint16_t timeout )
{
(void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Stat
//------------------------------------------------------------------------
virtual XRootDStatus Stat( bool force,
ResponseHandler *handler,
uint16_t timeout )
{
(void)force; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Read
//------------------------------------------------------------------------
virtual XRootDStatus Read( uint64_t offset,
uint32_t size,
void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
(void)offset; (void)size; (void)buffer; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Read
//------------------------------------------------------------------------
virtual XRootDStatus Read( uint64_t offset,
uint32_t size,
Optional<uint64_t> fdoff,
int fd,
ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)offset; (void)size; (void)fdoff; (void)fd, (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl:File PgRead
//------------------------------------------------------------------------
virtual XRootDStatus PgRead( uint64_t offset,
uint32_t nbpgs,
void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
(void)offset; (void)nbpgs; (void)buffer; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Write
//------------------------------------------------------------------------
virtual XRootDStatus Write( uint64_t offset,
uint32_t size,
const void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
(void)offset; (void)size; (void)buffer; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Write
//------------------------------------------------------------------------
virtual XRootDStatus Write( uint64_t offset,
Buffer &&buffer,
ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)offset; (void)buffer; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Write
//------------------------------------------------------------------------
virtual XRootDStatus Write( uint64_t offset,
uint32_t size,
Optional<uint64_t> fdoff,
int fd,
ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)offset; (void)size; (void)fdoff; (void)fd, (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::PgWrite
//------------------------------------------------------------------------
virtual XRootDStatus PgWrite( uint64_t offset,
uint32_t nbpgs,
const void *buffer,
std::vector<uint32_t> &cksums,
ResponseHandler *handler,
uint16_t timeout )
{
(void)offset; (void)nbpgs; (void)buffer; (void)cksums, (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Sync
//------------------------------------------------------------------------
virtual XRootDStatus Sync( ResponseHandler *handler,
uint16_t timeout )
{
(void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Truncate
//------------------------------------------------------------------------
virtual XRootDStatus Truncate( uint64_t size,
ResponseHandler *handler,
uint16_t timeout )
{
(void)size; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::VectorRead
//------------------------------------------------------------------------
virtual XRootDStatus VectorRead( const ChunkList &chunks,
void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
(void)chunks; (void)buffer; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::VectorWrite
//------------------------------------------------------------------------
virtual XRootDStatus VectorWrite( const ChunkList &chunks,
ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)chunks; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::WriteV
//------------------------------------------------------------------------
virtual XRootDStatus WriteV( uint64_t offset,
const struct iovec *iov,
int iovcnt,
ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)offset; (void)iov; (void)iovcnt; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Fcntl
//------------------------------------------------------------------------
virtual XRootDStatus Fcntl( const Buffer &arg,
ResponseHandler *handler,
uint16_t timeout )
{
(void)arg; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::Visa
//------------------------------------------------------------------------
virtual XRootDStatus Visa( ResponseHandler *handler,
uint16_t timeout )
{
(void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::File::IsOpen
//------------------------------------------------------------------------
virtual bool IsOpen() const
{
return false;
}
//------------------------------------------------------------------------
//! @see XrdCl::File::SetProperty
//------------------------------------------------------------------------
virtual bool SetProperty( const std::string &name,
const std::string &value )
{
(void)name; (void)value;
return false;
}
//------------------------------------------------------------------------
//! @see XrdCl::File::GetProperty
//------------------------------------------------------------------------
virtual bool GetProperty( const std::string &name,
std::string &value ) const
{
(void)name; (void)value;
return false;
}
};
//----------------------------------------------------------------------------
//! An interface for file plug-ins
//----------------------------------------------------------------------------
class FileSystemPlugIn
{
public:
//------------------------------------------------------------------------
//! Destructor
//------------------------------------------------------------------------
virtual ~FileSystemPlugIn() {}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Locate
//------------------------------------------------------------------------
virtual XRootDStatus Locate( const std::string &path,
OpenFlags::Flags flags,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)flags; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::DeepLocate
//------------------------------------------------------------------------
virtual XRootDStatus DeepLocate( const std::string &path,
OpenFlags::Flags flags,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)flags; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Mv
//------------------------------------------------------------------------
virtual XRootDStatus Mv( const std::string &source,
const std::string &dest,
ResponseHandler *handler,
uint16_t timeout )
{
(void)source; (void)dest; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Query
//------------------------------------------------------------------------
virtual XRootDStatus Query( QueryCode::Code queryCode,
const Buffer &arg,
ResponseHandler *handler,
uint16_t timeout )
{
(void)queryCode; (void)arg; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Truncate
//------------------------------------------------------------------------
virtual XRootDStatus Truncate( const std::string &path,
uint64_t size,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)size; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Rm
//------------------------------------------------------------------------
virtual XRootDStatus Rm( const std::string &path,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::MkDir
//------------------------------------------------------------------------
virtual XRootDStatus MkDir( const std::string &path,
MkDirFlags::Flags flags,
Access::Mode mode,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)flags; (void)mode; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::RmDir
//------------------------------------------------------------------------
virtual XRootDStatus RmDir( const std::string &path,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::ChMod
//------------------------------------------------------------------------
virtual XRootDStatus ChMod( const std::string &path,
Access::Mode mode,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)mode; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Ping
//------------------------------------------------------------------------
virtual XRootDStatus Ping( ResponseHandler *handler,
uint16_t timeout )
{
(void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Stat
//------------------------------------------------------------------------
virtual XRootDStatus Stat( const std::string &path,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::StatVFS
//------------------------------------------------------------------------
virtual XRootDStatus StatVFS( const std::string &path,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Protocol
//------------------------------------------------------------------------
virtual XRootDStatus Protocol( ResponseHandler *handler,
uint16_t timeout = 0 )
{
(void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::DirlList
//------------------------------------------------------------------------
virtual XRootDStatus DirList( const std::string &path,
DirListFlags::Flags flags,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)flags; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::SendInfo
//------------------------------------------------------------------------
virtual XRootDStatus SendInfo( const std::string &info,
ResponseHandler *handler,
uint16_t timeout )
{
(void)info; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::Prepare
//------------------------------------------------------------------------
virtual XRootDStatus Prepare( const std::vector<std::string> &fileList,
PrepareFlags::Flags flags,
uint8_t priority,
ResponseHandler *handler,
uint16_t timeout )
{
(void)fileList; (void)flags; (void)priority; (void)handler;
(void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::SetXAttr
//------------------------------------------------------------------------
virtual XRootDStatus SetXAttr( const std::string &path,
const std::vector<xattr_t> &attrs,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)attrs; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::GetXAttr
//------------------------------------------------------------------------
virtual XRootDStatus GetXAttr( const std::string &path,
const std::vector<std::string> &attrs,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)attrs; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::DelXAttr
//------------------------------------------------------------------------
virtual XRootDStatus DelXAttr( const std::string &path,
const std::vector<std::string> &attrs,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)attrs; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::ListXAttr
//------------------------------------------------------------------------
virtual XRootDStatus ListXAttr( const std::string &path,
ResponseHandler *handler,
uint16_t timeout )
{
(void)path; (void)handler; (void)timeout;
return XRootDStatus( stError, errNotImplemented );
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::SetProperty
//------------------------------------------------------------------------
virtual bool SetProperty( const std::string &name,
const std::string &value )
{
(void)name; (void)value;
return false;
}
//------------------------------------------------------------------------
//! @see XrdCl::FileSystem::GetProperty
//------------------------------------------------------------------------
virtual bool GetProperty( const std::string &name,
std::string &value ) const
{
(void)name; (void)value;
return false;
}
};
//----------------------------------------------------------------------------
//! Plugin factory
//----------------------------------------------------------------------------
class PlugInFactory
{
public:
//------------------------------------------------------------------------
//! Destructor
//------------------------------------------------------------------------
virtual ~PlugInFactory() {}
//------------------------------------------------------------------------
//! Create a file plug-in for the given URL
//------------------------------------------------------------------------
virtual FilePlugIn *CreateFile( const std::string &url ) = 0;
//------------------------------------------------------------------------
//! Create a file system plug-in for the given URL
//------------------------------------------------------------------------
virtual FileSystemPlugIn *CreateFileSystem( const std::string &url ) = 0;
};
}
#endif // __XRD_CL_PLUGIN_INTERFACE__