cefpython/src/include/cef_request.h at cefpython49-winxp · 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

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

// 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_REQUEST_H_

#define CEF_INCLUDE_CEF_REQUEST_H_

#pragma once

#include "include/cef_base.h"

#include <map>

#include <vector>

class CefPostData;

class CefPostDataElement;

///

// Class used to represent a web request. The methods of this class may be

// called on any thread.

///

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

class CefRequest : public virtual CefBase {

public:

typedef std::multimap<CefString, CefString> HeaderMap;

typedef cef_referrer_policy_t ReferrerPolicy;

typedef cef_resource_type_t ResourceType;

typedef cef_transition_type_t TransitionType;

///

// Create a new CefRequest object.

///

/*--cef()--*/

static CefRefPtr<CefRequest> Create();

///

// Returns true if this object is read-only.

///

/*--cef()--*/

virtual bool IsReadOnly() =0;

///

// Get the fully qualified URL.

///

/*--cef()--*/

virtual CefString GetURL() =0;

///

// Set the fully qualified URL.

///

/*--cef()--*/

virtual void SetURL(const CefString& url) =0;

///

// Get the request method type. The value will default to POST if post data

// is provided and GET otherwise.

///

/*--cef()--*/

virtual CefString GetMethod() =0;

///

// Set the request method type.

///

/*--cef()--*/

virtual void SetMethod(const CefString& method) =0;

///

// Set the referrer URL and policy. If non-empty the referrer URL must be

// fully qualified with an HTTP or HTTPS scheme component. Any username,

// password or ref component will be removed.

///

/*--cef()--*/

virtual void SetReferrer(const CefString& referrer_url,

ReferrerPolicy policy) =0;

///

// Get the referrer URL.

///

/*--cef()--*/

virtual CefString GetReferrerURL() =0;

///

// Get the referrer policy.

///

/*--cef(default_retval=REFERRER_POLICY_DEFAULT)--*/

virtual ReferrerPolicy GetReferrerPolicy() =0;

///

// Get the post data.

///

/*--cef()--*/

virtual CefRefPtr<CefPostData> GetPostData() =0;

///

// Set the post data.

///

/*--cef()--*/

virtual void SetPostData(CefRefPtr<CefPostData> postData) =0;

///

// Get the header values. Will not include the Referer value if any.

///

/*--cef()--*/

virtual void GetHeaderMap(HeaderMap& headerMap) =0;

///

// Set the header values. If a Referer value exists in the header map it will

// be removed and ignored.

///

/*--cef()--*/

virtual void SetHeaderMap(const HeaderMap& headerMap) =0;

///

// Set all values at one time.

///

/*--cef(optional_param=postData)--*/

virtual void Set(const CefString& url,

const CefString& method,

CefRefPtr<CefPostData> postData,

const HeaderMap& headerMap) =0;

///

// Get the flags used in combination with CefURLRequest. See

// cef_urlrequest_flags_t for supported values.

///

/*--cef(default_retval=UR_FLAG_NONE)--*/

virtual int GetFlags() =0;

///

// Set the flags used in combination with CefURLRequest. See

// cef_urlrequest_flags_t for supported values.

///

/*--cef()--*/

virtual void SetFlags(int flags) =0;

///

// Set the URL to the first party for cookies used in combination with

// CefURLRequest.

///

/*--cef()--*/

virtual CefString GetFirstPartyForCookies() =0;

///

// Get the URL to the first party for cookies used in combination with

// CefURLRequest.

///

/*--cef()--*/

virtual void SetFirstPartyForCookies(const CefString& url) =0;

///

// Get the resource type for this request. Only available in the browser

// process.

///

/*--cef(default_retval=RT_SUB_RESOURCE)--*/

virtual ResourceType GetResourceType() =0;

///

// Get the transition type for this request. Only available in the browser

// process and only applies to requests that represent a main frame or

// sub-frame navigation.

///

/*--cef(default_retval=TT_EXPLICIT)--*/

virtual TransitionType GetTransitionType() =0;

///

// Returns the globally unique identifier for this request or 0 if not

// specified. Can be used by CefRequestHandler implementations in the browser

// process to track a single request across multiple callbacks.

///

/*--cef()--*/

virtual uint64 GetIdentifier() =0;

};

///

// Class used to represent post data for a web request. The methods of this

// class may be called on any thread.

///

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

class CefPostData : public virtual CefBase {

public:

typedef std::vector<CefRefPtr<CefPostDataElement> > ElementVector;

///

// Create a new CefPostData object.

///

/*--cef()--*/

static CefRefPtr<CefPostData> Create();

///

// Returns true if this object is read-only.

///

/*--cef()--*/

virtual bool IsReadOnly() =0;

///

// Returns true if the underlying POST data includes elements that are not

// represented by this CefPostData object (for example, multi-part file upload

// data). Modifying CefPostData objects with excluded elements may result in

// the request failing.

///

/*--cef()--*/

virtual bool HasExcludedElements() = 0;

///

// Returns the number of existing post data elements.

///

/*--cef()--*/

virtual size_t GetElementCount() =0;

///

// Retrieve the post data elements.

///

/*--cef(count_func=elements:GetElementCount)--*/

virtual void GetElements(ElementVector& elements) =0;

///

// Remove the specified post data element. Returns true if the removal

// succeeds.

///

/*--cef()--*/

virtual bool RemoveElement(CefRefPtr<CefPostDataElement> element) =0;

///

// Add the specified post data element. Returns true if the add succeeds.

///

/*--cef()--*/

virtual bool AddElement(CefRefPtr<CefPostDataElement> element) =0;

///

// Remove all existing post data elements.

///

/*--cef()--*/

virtual void RemoveElements() =0;

};

///

// Class used to represent a single element in the request post data. The

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

///

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

class CefPostDataElement : public virtual CefBase {

public:

///

// Post data elements may represent either bytes or files.

///

typedef cef_postdataelement_type_t Type;

///

// Create a new CefPostDataElement object.

///

/*--cef()--*/

static CefRefPtr<CefPostDataElement> Create();

///

// Returns true if this object is read-only.

///

/*--cef()--*/

virtual bool IsReadOnly() =0;

///

// Remove all contents from the post data element.

///

/*--cef()--*/

virtual void SetToEmpty() =0;

///

// The post data element will represent a file.

///

/*--cef()--*/

virtual void SetToFile(const CefString& fileName) =0;

///

// The post data element will represent bytes. The bytes passed

// in will be copied.

///

/*--cef()--*/

virtual void SetToBytes(size_t size, const void* bytes) =0;

///

// Return the type of this post data element.

///

/*--cef(default_retval=PDE_TYPE_EMPTY)--*/

virtual Type GetType() =0;

///

// Return the file name.

///

/*--cef()--*/

virtual CefString GetFile() =0;

///

// Return the number of bytes.

///

/*--cef()--*/

virtual size_t GetBytesCount() =0;

///

// Read up to |size| bytes into |bytes| and return the number of bytes

// actually read.

///

/*--cef()--*/

virtual size_t GetBytes(size_t size, void* bytes) =0;

};

#endif // CEF_INCLUDE_CEF_REQUEST_H_

cefpython/src/include/cef_request.h at cefpython49-winxp · pythonthings/cefpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cef_request.h

Latest commit

History

Breadcrumbs

cef_request.h

File metadata and controls