cefpython/src/include/cef_stream.h at cefpython51 · pythonthings/cefpython · GitHub

Repository navigation

History

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

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

// * Neither the name of Google Inc. nor the name Chromium Embedded

// Framework nor the names of its contributors may be used to endorse

// or promote products derived from this software without specific prior

// written permission.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// ---------------------------------------------------------------------------

// The contents of this file must follow a specific format in order to

// support the CEF translator tool. See the translator.README.txt file in the

// tools directory for more information.

#ifndef CEF_INCLUDE_CEF_STREAM_H_

#define CEF_INCLUDE_CEF_STREAM_H_

#include "include/cef_base.h"

///

// Interface the client can implement to provide a custom stream reader. The

// methods of this class may be called on any thread.

///

/*--cef(source=client)--*/

class CefReadHandler : public virtual CefBase {

public:

///

// Read raw binary data.

///

/*--cef()--*/

virtual size_t Read(void* ptr, size_t size, size_t n) =0;

///

// Seek to the specified offset position. |whence| may be any one of

// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on

// failure.

///

/*--cef()--*/

virtual int Seek(int64 offset, int whence) =0;

///

// Return the current offset position.

///

/*--cef()--*/

virtual int64 Tell() =0;

///

// Return non-zero if at end of file.

///

/*--cef()--*/

virtual int Eof() =0;

///

// Return true if this handler performs work like accessing the file system

// which may block. Used as a hint for determining the thread to access the

// handler from.

///

/*--cef()--*/

virtual bool MayBlock() =0;

};

///

// Class used to read data from a stream. The methods of this class may be

// called on any thread.

///

/*--cef(source=library)--*/

class CefStreamReader : public virtual CefBase {

public:

///

// Create a new CefStreamReader object from a file.

///

/*--cef()--*/

static CefRefPtr<CefStreamReader> CreateForFile(const CefString& fileName);

///

// Create a new CefStreamReader object from data.

///

/*--cef()--*/

static CefRefPtr<CefStreamReader> CreateForData(void* data, size_t size);

///

// Create a new CefStreamReader object from a custom handler.

///

/*--cef()--*/

static CefRefPtr<CefStreamReader> CreateForHandler(

CefRefPtr<CefReadHandler> handler);

///

// Read raw binary data.

///

/*--cef()--*/

virtual size_t Read(void* ptr, size_t size, size_t n) =0;

///

// Seek to the specified offset position. |whence| may be any one of

// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on

// failure.

///

/*--cef()--*/

virtual int Seek(int64 offset, int whence) =0;

///

// Return the current offset position.

///

/*--cef()--*/

virtual int64 Tell() =0;

///

// Return non-zero if at end of file.

///

/*--cef()--*/

virtual int Eof() =0;

///

// Returns true if this reader performs work like accessing the file system

// which may block. Used as a hint for determining the thread to access the

// reader from.

///

/*--cef()--*/

virtual bool MayBlock() =0;

};

///

// Interface the client can implement to provide a custom stream writer. The

// methods of this class may be called on any thread.

///

/*--cef(source=client)--*/

class CefWriteHandler : public virtual CefBase {

public:

///

// Write raw binary data.

///

/*--cef()--*/

virtual size_t Write(const void* ptr, size_t size, size_t n) =0;

///

// Seek to the specified offset position. |whence| may be any one of

// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on

// failure.

///

/*--cef()--*/

virtual int Seek(int64 offset, int whence) =0;

///

// Return the current offset position.

///

/*--cef()--*/

virtual int64 Tell() =0;

///

// Flush the stream.

///

/*--cef()--*/

virtual int Flush() =0;

///

// Return true if this handler performs work like accessing the file system

// which may block. Used as a hint for determining the thread to access the

// handler from.

///

/*--cef()--*/

virtual bool MayBlock() =0;

};

///

// Class used to write data to a stream. The methods of this class may be called

// on any thread.

///

/*--cef(source=library)--*/

class CefStreamWriter : public virtual CefBase {

public:

///

// Create a new CefStreamWriter object for a file.

///

/*--cef()--*/

static CefRefPtr<CefStreamWriter> CreateForFile(const CefString& fileName);

///

// Create a new CefStreamWriter object for a custom handler.

///

/*--cef()--*/

static CefRefPtr<CefStreamWriter> CreateForHandler(

CefRefPtr<CefWriteHandler> handler);

///

// Write raw binary data.

///

/*--cef()--*/

virtual size_t Write(const void* ptr, size_t size, size_t n) =0;

///

// Seek to the specified offset position. |whence| may be any one of

// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on

// failure.

///

/*--cef()--*/

virtual int Seek(int64 offset, int whence) =0;

///

// Return the current offset position.

///

/*--cef()--*/

virtual int64 Tell() =0;

///

// Flush the stream.

///

/*--cef()--*/

virtual int Flush() =0;

///

// Returns true if this writer performs work like accessing the file system

// which may block. Used as a hint for determining the thread to access the

// writer from.

///

/*--cef()--*/

virtual bool MayBlock() =0;

};

#endif // CEF_INCLUDE_CEF_STREAM_H_

cefpython/src/include/cef_stream.h at cefpython51 · pythonthings/cefpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cef_stream.h

Latest commit

History

Breadcrumbs

cef_stream.h

File metadata and controls