xrootd
XrdSfsXio.hh
Go to the documentation of this file.
1#ifndef __SFS_XIO_H__
2#define __SFS_XIO_H__
3/******************************************************************************/
4/* */
5/* X r d S f s X i o . h h */
6/* */
7/* (c) 2013 by the Board of Trustees of the Leland Stanford, Jr., University */
8/* Produced by Andrew Hanushevsky for Stanford University under contract */
9/* DE-AC02-76-SFO0515 with the Department of Energy */
10/* */
11/* This file is part of the XRootD software suite. */
12/* */
13/* XRootD is free software: you can redistribute it and/or modify it under */
14/* the terms of the GNU Lesser General Public License as published by the */
15/* Free Software Foundation, either version 3 of the License, or (at your */
16/* option) any later version. */
17/* */
18/* XRootD is distributed in the hope that it will be useful, but WITHOUT */
19/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
20/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
21/* License for more details. */
22/* */
23/* You should have received a copy of the GNU Lesser General Public License */
24/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
25/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
26/* */
27/* The copyright holder's institutional names and contributor's names may not */
28/* be used to endorse or promote products derived from this software without */
29/* specific prior written permission of the institution or contributor. */
30/******************************************************************************/
31
32//-----------------------------------------------------------------------------
43//-----------------------------------------------------------------------------
44
45//-----------------------------------------------------------------------------
48//-----------------------------------------------------------------------------
49
51{
52public:
53
54//-----------------------------------------------------------------------------
61//-----------------------------------------------------------------------------
62
63virtual char *Buffer(int **blen=0) = 0;
64
65//-----------------------------------------------------------------------------
68//-----------------------------------------------------------------------------
69
70virtual void Recycle() = 0;
71
73virtual ~XrdSfsXioHandle() {}
74};
75
76/******************************************************************************/
77/* C l a s s X r d S f s X i o */
78/******************************************************************************/
79
81{
82public:
83
84//-----------------------------------------------------------------------------
86//-----------------------------------------------------------------------------
87
88enum XioStatus {allOK = 0,
92 TooMany
93 };
94
95//-----------------------------------------------------------------------------
110//-----------------------------------------------------------------------------
111
112virtual XioStatus Swap(const char * curBuff,
113 XrdSfsXioHandle *&curHand,
114 XrdSfsXioHandle * oldHand=0
115 ) = 0;
116
117//-----------------------------------------------------------------------------
119//-----------------------------------------------------------------------------
120
122virtual ~XrdSfsXio() {}
123};
124#endif
Definition: XrdSfsXio.hh:51
virtual void Recycle()=0
virtual ~XrdSfsXioHandle()
Definition: XrdSfsXio.hh:73
XrdSfsXioHandle()
Definition: XrdSfsXio.hh:72
virtual char * Buffer(int **blen=0)=0
Definition: XrdSfsXio.hh:81
XioStatus
Values return by Swap().
Definition: XrdSfsXio.hh:88
@ allOK
Successful completion.
Definition: XrdSfsXio.hh:88
@ TooMany
Swap failed, too many buffs outstanding.
Definition: XrdSfsXio.hh:92
@ BadHandle
Swap failed, oHandle is bad.
Definition: XrdSfsXio.hh:90
@ BadBuff
Swap failed, curBuff is bad.
Definition: XrdSfsXio.hh:89
@ NotWrite
Swap failed, not from a write() call.
Definition: XrdSfsXio.hh:91
XrdSfsXio()
Constructor and destructor.
Definition: XrdSfsXio.hh:121
virtual ~XrdSfsXio()
Definition: XrdSfsXio.hh:122
virtual XioStatus Swap(const char *curBuff, XrdSfsXioHandle *&curHand, XrdSfsXioHandle *oldHand=0)=0