xrootd
XrdSsiStream.hh
Go to the documentation of this file.
1 #ifndef __XRDSSISTREAM_HH__
2 #define __XRDSSISTREAM_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d S s i S t r e a m . 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 #include <errno.h>
33 
34 #include "XrdSsi/XrdSsiErrInfo.hh"
35 
36 //-----------------------------------------------------------------------------
51 //-----------------------------------------------------------------------------
52 
54 {
55 public:
56 
57 //-----------------------------------------------------------------------------
61 //-----------------------------------------------------------------------------
62 
63 class Buffer
64 {
65 public:
66 virtual void Recycle() = 0;
67 
68 char *data;
70 
71  Buffer(char *dp=0) : data(dp), next(0) {}
72 virtual ~Buffer() {}
73 };
74 
75 //-----------------------------------------------------------------------------
91 //-----------------------------------------------------------------------------
92 
93 virtual Buffer *GetBuff(XrdSsiErrInfo &eRef, int &dlen, bool &last)
94  {eRef.Set("Not an active stream", EOPNOTSUPP); return 0;}
95 
96 //-----------------------------------------------------------------------------
110 //-----------------------------------------------------------------------------
111 
112 virtual bool SetBuff(XrdSsiErrInfo &eRef, char *buff, int blen)
113  {eRef.Set("Not a passive stream", EOPNOTSUPP); return false;}
114 
115 //-----------------------------------------------------------------------------
129 //-----------------------------------------------------------------------------
130 
131 virtual int SetBuff(XrdSsiErrInfo &eRef, char *buff, int blen, bool &last)
132  {eRef.Set("Not a passive stream", EOPNOTSUPP); return 0;}
133 
134 //-----------------------------------------------------------------------------
142 //-----------------------------------------------------------------------------
143 
145 
146 //-----------------------------------------------------------------------------
150 //-----------------------------------------------------------------------------
151 
152 StreamType Type() {return SType;}
153 
154  XrdSsiStream(StreamType stype) : SType(stype) {}
155 
156 virtual ~XrdSsiStream() {}
157 
158 protected:
159 
161 };
162 #endif
Buffer(char *dp=0)
For chaining by buffer receiver
Definition: XrdSsiStream.hh:71
Definition: XrdSsiStream.hh:63
const StreamType SType
Definition: XrdSsiStream.hh:160
void Set(const char *eMsg=0, int eNum=0, int eArg=0)
Definition: XrdSsiErrInfo.hh:103
Buffer * next
-> Buffer containing the data
Definition: XrdSsiStream.hh:69
virtual int SetBuff(XrdSsiErrInfo &eRef, char *buff, int blen, bool &last)
Definition: XrdSsiStream.hh:131
StreamType
Definition: XrdSsiStream.hh:144
XrdSsiStream(StreamType stype)
Definition: XrdSsiStream.hh:154
char * data
Call to recycle the buffer when finished
Definition: XrdSsiStream.hh:68
StreamType Type()
Definition: XrdSsiStream.hh:152
virtual bool SetBuff(XrdSsiErrInfo &eRef, char *buff, int blen)
Definition: XrdSsiStream.hh:112
virtual void Recycle()=0
Definition: XrdSsiStream.hh:144
Definition: XrdSsiStream.hh:53
Definition: XrdSsiErrInfo.hh:40
virtual Buffer * GetBuff(XrdSsiErrInfo &eRef, int &dlen, bool &last)
Definition: XrdSsiStream.hh:93
virtual ~Buffer()
Definition: XrdSsiStream.hh:72
virtual ~XrdSsiStream()
Definition: XrdSsiStream.hh:156
Definition: XrdSsiStream.hh:144