Implement this interface to handle events related to browser requests. More...
#include "include/cef_request_handler.h"
Public Types | |
| typedef cef_termination_status_t | TerminationStatus |
| typedef cef_window_open_disposition_t | WindowOpenDisposition |
| typedef std::vector< CefRefPtr< CefX509Certificate > > | X509CertificateList |
Public Member Functions | |
| virtual bool | OnBeforeBrowse (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool user_gesture, bool is_redirect) |
| Called on the UI thread before browser navigation. More... | |
| virtual bool | OnOpenURLFromTab (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, const CefString &target_url, WindowOpenDisposition target_disposition, bool user_gesture) |
| Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable. More... | |
| virtual CefRefPtr< CefResourceRequestHandler > | GetResourceRequestHandler (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool is_navigation, bool is_download, const CefString &request_initiator, bool &disable_default_handling) |
| Called on the browser process IO thread before a resource request is initiated. More... | |
| virtual bool | GetAuthCredentials (CefRefPtr< CefBrowser > browser, const CefString &origin_url, bool isProxy, const CefString &host, int port, const CefString &realm, const CefString &scheme, CefRefPtr< CefAuthCallback > callback) |
| Called on the IO thread when the browser needs credentials from the user. More... | |
| virtual bool | OnCertificateError (CefRefPtr< CefBrowser > browser, cef_errorcode_t cert_error, const CefString &request_url, CefRefPtr< CefSSLInfo > ssl_info, CefRefPtr< CefCallback > callback) |
| Called on the UI thread to handle requests for URLs with an invalid SSL certificate. More... | |
| virtual bool | OnSelectClientCertificate (CefRefPtr< CefBrowser > browser, bool isProxy, const CefString &host, int port, const X509CertificateList &certificates, CefRefPtr< CefSelectClientCertificateCallback > callback) |
| Called on the UI thread when a client certificate is being requested for authentication. More... | |
| virtual void | OnRenderViewReady (CefRefPtr< CefBrowser > browser) |
| Called on the browser process UI thread when the render view associated with |browser| is ready to receive/handle IPC messages in the render process. More... | |
| virtual bool | OnRenderProcessUnresponsive (CefRefPtr< CefBrowser > browser, CefRefPtr< CefUnresponsiveProcessCallback > callback) |
| Called on the browser process UI thread when the render process is unresponsive as indicated by a lack of input event processing for at least 15 seconds. More... | |
| virtual void | OnRenderProcessResponsive (CefRefPtr< CefBrowser > browser) |
| Called on the browser process UI thread when the render process becomes responsive after previously being unresponsive. More... | |
| virtual void | OnRenderProcessTerminated (CefRefPtr< CefBrowser > browser, TerminationStatus status, int error_code, const CefString &error_string) |
| Called on the browser process UI thread when the render process terminates unexpectedly. More... | |
| virtual void | OnDocumentAvailableInMainFrame (CefRefPtr< CefBrowser > browser) |
| Called on the browser process UI thread when the window.document object of the main frame has been created. 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
Implement this interface to handle events related to browser requests.
The methods of this class will be called on the thread indicated.
Member Typedef Documentation
◆ TerminationStatus
◆ WindowOpenDisposition
◆ X509CertificateList
| typedef std::vector<CefRefPtr<CefX509Certificate> > CefRequestHandler::X509CertificateList |
Member Function Documentation
◆ GetAuthCredentials()
|
inlinevirtual |
Called on the IO thread when the browser needs credentials from the user.
|origin_url| is the origin making this authentication request. |isProxy| indicates whether the host is a proxy server. |host| contains the hostname and |port| contains the port number. |realm| is the realm of the challenge and may be empty. |scheme| is the authentication scheme used, such as "basic" or "digest", and will be empty if the source of the request is an FTP server. Return true to continue the request and call CefAuthCallback::Continue() either in this method or at a later time when the authentication information is available. Return false to cancel the request immediately.
◆ GetResourceRequestHandler()
|
inlinevirtual |
Called on the browser process IO thread before a resource request is initiated.
The |browser| and |frame| values represent the source of the request. |request| represents the request contents and cannot be modified in this callback. |is_navigation| will be true if the resource request is a navigation. |is_download| will be true if the resource request is a download. |request_initiator| is the origin (scheme + domain) of the page that initiated the request. Set |disable_default_handling| to true to disable default handling of the request, in which case it will need to be handled via CefResourceRequestHandler::GetResourceHandler or it will be canceled. To allow the resource load to proceed with default handling return NULL. To specify a handler for the resource return a CefResourceRequestHandler object. If this callback returns NULL the same method will be called on the associated CefRequestContextHandler, if any.
◆ OnBeforeBrowse()
|
inlinevirtual |
Called on the UI thread before browser navigation.
Return true to cancel the navigation or false to allow the navigation to proceed. The |request| object cannot be modified in this callback. CefLoadHandler::OnLoadingStateChange will be called twice in all cases. If the navigation is allowed CefLoadHandler::OnLoadStart and CefLoadHandler::OnLoadEnd will be called. If the navigation is canceled CefLoadHandler::OnLoadError will be called with an |errorCode| value of ERR_ABORTED. The |user_gesture| value will be true if the browser navigated via explicit user gesture (e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event).
◆ OnCertificateError()
|
inlinevirtual |
Called on the UI thread to handle requests for URLs with an invalid SSL certificate.
Return true and call CefCallback methods either in this method or at a later time to continue or cancel the request. Return false to cancel the request immediately. If cef_settings_t.ignore_certificate_errors is set all invalid certificates will be accepted without calling this method.
◆ OnDocumentAvailableInMainFrame()
|
inlinevirtual |
Called on the browser process UI thread when the window.document object of the main frame has been created.
◆ OnOpenURLFromTab()
|
inlinevirtual |
Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable.
This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-level frame to/from a file URL). The |browser| and |frame| values represent the source of the navigation. The |target_disposition| value indicates where the user intended to navigate the browser based on standard Chromium behaviors (e.g. current tab, new tab, etc). The |user_gesture| value will be true if the browser navigated via explicit user gesture (e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event). Return true to cancel the navigation or false to allow the navigation to proceed in the source browser's top-level frame.
◆ OnRenderProcessResponsive()
|
inlinevirtual |
Called on the browser process UI thread when the render process becomes responsive after previously being unresponsive.
See documentation on OnRenderProcessUnresponsive.
◆ OnRenderProcessTerminated()
|
inlinevirtual |
Called on the browser process UI thread when the render process terminates unexpectedly.
|status| indicates how the process terminated. |error_code| and |error_string| represent the error that would be displayed in Chrome's "Aw, Snap!" view. Possible |error_code| values include cef_resultcode_t non-normal exit values and platform-specific crash values (for example, a Posix signal or Windows hardware exception).
◆ OnRenderProcessUnresponsive()
|
inlinevirtual |
Called on the browser process UI thread when the render process is unresponsive as indicated by a lack of input event processing for at least 15 seconds.
Return false for the default behavior which is an indefinite wait with Alloy style or display of the "Page
unresponsive" dialog with Chrome style. Return true and don't execute the callback for an indefinite wait without display of the Chrome style dialog. Return true and call CefUnresponsiveProcessCallback::Wait either in this method or at a later time to reset the wait timer, potentially triggering another call to this method if the process remains unresponsive. Return true and call CefUnresponsiveProcessCallback:: Terminate either in this method or at a later time to terminate the unresponsive process, resulting in a call to OnRenderProcessTerminated. OnRenderProcessResponsive will be called if the process becomes responsive after this method is called. This functionality depends on the hang monitor which can be disabled by passing the --disable-hang-monitor command-line flag.
◆ OnRenderViewReady()
|
inlinevirtual |
Called on the browser process UI thread when the render view associated with |browser| is ready to receive/handle IPC messages in the render process.
◆ OnSelectClientCertificate()
|
inlinevirtual |
Called on the UI thread when a client certificate is being requested for authentication.
Return false to use the default behavior. If the |certificates| list is not empty the default behavior will be to display a dialog for certificate selection. If the |certificates| list is empty then the default behavior will be not to show a dialog and it will continue without using any certificate. Return true and call CefSelectClientCertificateCallback::Select either in this method or at a later time to select a certificate. Do not call Select or call it with NULL to continue without using any certificate. |isProxy| indicates whether the host is an HTTPS proxy or the origin server. |host| and |port| contains the hostname and port of the SSL server. |certificates| is the list of certificates to choose from; this list has already been pruned by Chromium so that it only contains certificates from issuers that the server trusts.
The documentation for this class was generated from the following file:
- include/cef_request_handler.h
