XRootD
XrdXrootdGStream.hh
Go to the documentation of this file.
1 #ifndef __XRDXROOTDGSTREAM_HH_
2 #define __XRDXROOTDGSTREAM_HH_
3 /******************************************************************************/
4 /* */
5 /* X r d X r o o t G S t r e a m . h h */
6 /* */
7 /* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <cstdint>
34 
35 //-----------------------------------------------------------------------------
39 //-----------------------------------------------------------------------------
40 
41 class XrdXrootdGSReal;
42 
44 {
45 public:
46 
47 //-----------------------------------------------------------------------------
50 //-----------------------------------------------------------------------------
51 
52 void Flush();
53 
54 //-----------------------------------------------------------------------------
67 //-----------------------------------------------------------------------------
68 
69 uint32_t GetDictID(const char *text, bool isPath=false);
70 
71 //-----------------------------------------------------------------------------
77 //-----------------------------------------------------------------------------
78 
79 bool HasHdr();
80 
81 //-----------------------------------------------------------------------------
90 //-----------------------------------------------------------------------------
91 
92 bool Insert(const char *data, int dlen);
93 
94 //-----------------------------------------------------------------------------
105 //-----------------------------------------------------------------------------
106 
107 bool Insert(int dlen);
108 
109 //-----------------------------------------------------------------------------
118 //-----------------------------------------------------------------------------
119 
120 char *Reserve(int dlen);
121 
122 //-----------------------------------------------------------------------------
134 //-----------------------------------------------------------------------------
135 
136 int SetAutoFlush(int afsec);
137 
138 //-----------------------------------------------------------------------------
142 //-----------------------------------------------------------------------------
143 
144 int Space();
145 
146 //-----------------------------------------------------------------------------
148 //-----------------------------------------------------------------------------
149 static
150 const int MaxDataLen = 65280;
151 
152 //-----------------------------------------------------------------------------
156 //-----------------------------------------------------------------------------
157 
158  XrdXrootdGStream(XrdXrootdGSReal &gsRef) : gStream(gsRef) {}
159 
160 protected:
161 
162 //-----------------------------------------------------------------------------
164 //-----------------------------------------------------------------------------
165 
167 
168 private:
169 
170 XrdXrootdGSReal &gStream;
171 };
172 #endif
char * Reserve(int dlen)
int SetAutoFlush(int afsec)
uint32_t GetDictID(const char *text, bool isPath=false)
~XrdXrootdGStream()
Destructor. This stream should never be directly deleted.
XrdXrootdGStream(XrdXrootdGSReal &gsRef)
bool Insert(const char *data, int dlen)
static const int MaxDataLen
The larest amount of data that can be inserted in a single call to GStream.