Chromium Embedded Framework (CEF)  115.2.0+g096e3eb+chromium-115.0.5790.13
CefURLRequestClient Class Referenceabstract

Interface that should be implemented by the CefURLRequest client. More...

#include "include/cef_urlrequest.h"

Inheritance diagram for CefURLRequestClient:
CefBaseRefCounted

Public Member Functions

virtual void OnRequestComplete (CefRefPtr< CefURLRequest > request)=0
 Notifies the client that the request has completed. More...
 
virtual void OnUploadProgress (CefRefPtr< CefURLRequest > request, int64_t current, int64_t total)=0
 Notifies the client of upload progress. More...
 
virtual void OnDownloadProgress (CefRefPtr< CefURLRequest > request, int64_t current, int64_t total)=0
 Notifies the client of download progress. More...
 
virtual void OnDownloadData (CefRefPtr< CefURLRequest > request, const void *data, size_t data_length)=0
 Called when some part of the response is read. More...
 
virtual bool GetAuthCredentials (bool isProxy, const CefString &host, int port, const CefString &realm, const CefString &scheme, CefRefPtr< CefAuthCallback > callback)=0
 Called on the IO thread when the browser needs credentials from the user. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Interface that should be implemented by the CefURLRequest client.

The methods of this class will be called on the same thread that created the request unless otherwise documented.

Member Function Documentation

◆ GetAuthCredentials()

virtual bool CefURLRequestClient::GetAuthCredentials ( bool  isProxy,
const CefString host,
int  port,
const CefString realm,
const CefString scheme,
CefRefPtr< CefAuthCallback callback 
)
pure virtual

Called on the IO thread when the browser needs credentials from the user.

|isProxy| indicates whether the host is a proxy server. |host| contains the hostname and |port| contains the port number. Return true to continue the request and call CefAuthCallback::Continue() when the authentication information is available. If the request has an associated browser/frame then returning false will result in a call to GetAuthCredentials on the CefRequestHandler associated with that browser, if any. Otherwise, returning false will cancel the request immediately. This method will only be called for requests initiated from the browser process.

◆ OnDownloadData()

virtual void CefURLRequestClient::OnDownloadData ( CefRefPtr< CefURLRequest request,
const void *  data,
size_t  data_length 
)
pure virtual

Called when some part of the response is read.

|data| contains the current bytes received since the last call. This method will not be called if the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.

◆ OnDownloadProgress()

virtual void CefURLRequestClient::OnDownloadProgress ( CefRefPtr< CefURLRequest request,
int64_t  current,
int64_t  total 
)
pure virtual

Notifies the client of download progress.

|current| denotes the number of bytes received up to the call and |total| is the expected total size of the response (or -1 if not determined).

◆ OnRequestComplete()

virtual void CefURLRequestClient::OnRequestComplete ( CefRefPtr< CefURLRequest request)
pure virtual

Notifies the client that the request has completed.

Use the CefURLRequest::GetRequestStatus method to determine if the request was successful or not.

◆ OnUploadProgress()

virtual void CefURLRequestClient::OnUploadProgress ( CefRefPtr< CefURLRequest request,
int64_t  current,
int64_t  total 
)
pure virtual

Notifies the client of upload progress.

|current| denotes the number of bytes sent so far and |total| is the total size of uploading data (or -1 if chunked upload is enabled). This method will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.


The documentation for this class was generated from the following file: