mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
@ -47,11 +47,11 @@
|
||||
class CefURLRequestClient;
|
||||
|
||||
///
|
||||
// Class used to make a URL request. URL requests are not associated with a
|
||||
// browser instance so no CefClient callbacks will be executed. URL requests
|
||||
// can be created on any valid CEF thread in either the browser or render
|
||||
// process. Once created the methods of the URL request object must be accessed
|
||||
// on the same thread that created it.
|
||||
/// Class used to make a URL request. URL requests are not associated with a
|
||||
/// browser instance so no CefClient callbacks will be executed. URL requests
|
||||
/// can be created on any valid CEF thread in either the browser or render
|
||||
/// process. Once created the methods of the URL request object must be accessed
|
||||
/// on the same thread that created it.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefURLRequest : public virtual CefBaseRefCounted {
|
||||
@ -60,18 +60,19 @@ class CefURLRequest : public virtual CefBaseRefCounted {
|
||||
typedef cef_errorcode_t ErrorCode;
|
||||
|
||||
///
|
||||
// Create a new URL request that is not associated with a specific browser or
|
||||
// frame. Use CefFrame::CreateURLRequest instead if you want the request to
|
||||
// have this association, in which case it may be handled differently (see
|
||||
// documentation on that method). A request created with this method may only
|
||||
// originate from the browser process, and will behave as follows:
|
||||
// - It may be intercepted by the client via CefResourceRequestHandler or
|
||||
// CefSchemeHandlerFactory.
|
||||
// - POST data may only contain only a single element of type PDE_TYPE_FILE
|
||||
// or PDE_TYPE_BYTES.
|
||||
// - If |request_context| is empty the global request context will be used.
|
||||
//
|
||||
// The |request| object will be marked as read-only after calling this method.
|
||||
/// Create a new URL request that is not associated with a specific browser or
|
||||
/// frame. Use CefFrame::CreateURLRequest instead if you want the request to
|
||||
/// have this association, in which case it may be handled differently (see
|
||||
/// documentation on that method). A request created with this method may only
|
||||
/// originate from the browser process, and will behave as follows:
|
||||
/// - It may be intercepted by the client via CefResourceRequestHandler or
|
||||
/// CefSchemeHandlerFactory.
|
||||
/// - POST data may only contain only a single element of type PDE_TYPE_FILE
|
||||
/// or PDE_TYPE_BYTES.
|
||||
/// - If |request_context| is empty the global request context will be used.
|
||||
///
|
||||
/// The |request| object will be marked as read-only after calling this
|
||||
/// method.
|
||||
///
|
||||
/*--cef(optional_param=request_context)--*/
|
||||
static CefRefPtr<CefURLRequest> Create(
|
||||
@ -80,74 +81,74 @@ class CefURLRequest : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefRequestContext> request_context);
|
||||
|
||||
///
|
||||
// Returns the request object used to create this URL request. The returned
|
||||
// object is read-only and should not be modified.
|
||||
/// Returns the request object used to create this URL request. The returned
|
||||
/// object is read-only and should not be modified.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefRequest> GetRequest() = 0;
|
||||
|
||||
///
|
||||
// Returns the client.
|
||||
/// Returns the client.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefURLRequestClient> GetClient() = 0;
|
||||
|
||||
///
|
||||
// Returns the request status.
|
||||
/// Returns the request status.
|
||||
///
|
||||
/*--cef(default_retval=UR_UNKNOWN)--*/
|
||||
virtual Status GetRequestStatus() = 0;
|
||||
|
||||
///
|
||||
// Returns the request error if status is UR_CANCELED or UR_FAILED, or 0
|
||||
// otherwise.
|
||||
/// Returns the request error if status is UR_CANCELED or UR_FAILED, or 0
|
||||
/// otherwise.
|
||||
///
|
||||
/*--cef(default_retval=ERR_NONE)--*/
|
||||
virtual ErrorCode GetRequestError() = 0;
|
||||
|
||||
///
|
||||
// Returns the response, or NULL if no response information is available.
|
||||
// Response information will only be available after the upload has completed.
|
||||
// The returned object is read-only and should not be modified.
|
||||
/// Returns the response, or NULL if no response information is available.
|
||||
/// Response information will only be available after the upload has
|
||||
/// completed. The returned object is read-only and should not be modified.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefResponse> GetResponse() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the response body was served from the cache. This includes
|
||||
// responses for which revalidation was required.
|
||||
/// Returns true if the response body was served from the cache. This includes
|
||||
/// responses for which revalidation was required.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool ResponseWasCached() = 0;
|
||||
|
||||
///
|
||||
// Cancel the request.
|
||||
/// Cancel the request.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Cancel() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefURLRequestClient : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Notifies the client that the request has completed. Use the
|
||||
// CefURLRequest::GetRequestStatus method to determine if the request was
|
||||
// successful or not.
|
||||
/// Notifies the client that the request has completed. Use the
|
||||
/// CefURLRequest::GetRequestStatus method to determine if the request was
|
||||
/// successful or not.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnRequestComplete(CefRefPtr<CefURLRequest> request) = 0;
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnUploadProgress(CefRefPtr<CefURLRequest> request,
|
||||
@ -155,9 +156,9 @@ class CefURLRequestClient : public virtual CefBaseRefCounted {
|
||||
int64 total) = 0;
|
||||
|
||||
///
|
||||
// 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).
|
||||
/// 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).
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnDownloadProgress(CefRefPtr<CefURLRequest> request,
|
||||
@ -165,9 +166,9 @@ class CefURLRequestClient : public virtual CefBaseRefCounted {
|
||||
int64 total) = 0;
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnDownloadData(CefRefPtr<CefURLRequest> request,
|
||||
@ -175,15 +176,15 @@ class CefURLRequestClient : public virtual CefBaseRefCounted {
|
||||
size_t data_length) = 0;
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef(optional_param=realm)--*/
|
||||
virtual bool GetAuthCredentials(bool isProxy,
|
||||
|
||||
Reference in New Issue
Block a user