CefBrowserProcessHandler Class Reference

Class used to implement browser process callbacks. More...

#include "include/cef_browser_process_handler.h"

Inheritance diagram for CefBrowserProcessHandler:

Public Member Functions
virtual void	OnRegisterCustomPreferences (cef_preferences_type_t type, CefRawPtr< CefPreferenceRegistrar > registrar)
	Provides an opportunity to register custom preferences prior to global and request context initialization. More...
virtual void	OnContextInitialized ()
	Called on the browser process UI thread immediately after the CEF context has been initialized. More...
virtual void	OnBeforeChildProcessLaunch (CefRefPtr< CefCommandLine > command_line)
	Called before a child process is launched. More...
virtual void	OnScheduleMessagePumpWork (int64_t delay_ms)
	Called from any thread when work has been scheduled for the browser process main (UI) thread. More...
virtual CefRefPtr< CefClient >	GetDefaultClient ()
	Return the default client for use with a newly created browser window. 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

Class used to implement browser process callbacks.

The methods of this class will be called on the browser process main thread unless otherwise indicated.

Member Function Documentation

GetDefaultClient()

virtual CefRefPtr<CefClient> CefBrowserProcessHandler::GetDefaultClient ( )

inlinevirtual

Return the default client for use with a newly created browser window.

If null is returned the browser will be unmanaged (no callbacks will be executed for that browser) and application shutdown will be blocked until the browser window is closed manually. This method is currently only used with the chrome runtime.

OnBeforeChildProcessLaunch()

virtual void CefBrowserProcessHandler::OnBeforeChildProcessLaunch ( CefRefPtr< CefCommandLine >  command_line )

inlinevirtual

Called before a child process is launched.

Will be called on the browser process UI thread when launching a render process and on the browser process IO thread when launching a GPU process. Provides an opportunity to modify the child process command line. Do not keep a reference to |command_line| outside of this method.

OnContextInitialized()

virtual void CefBrowserProcessHandler::OnContextInitialized ( )

inlinevirtual

Called on the browser process UI thread immediately after the CEF context has been initialized.

OnRegisterCustomPreferences()

virtual void CefBrowserProcessHandler::OnRegisterCustomPreferences ( cef_preferences_type_t  type, CefRawPtr< CefPreferenceRegistrar >  registrar  )

inlinevirtual

Provides an opportunity to register custom preferences prior to global and request context initialization.

If |type| is CEF_PREFERENCES_TYPE_GLOBAL the registered preferences can be accessed via CefPreferenceManager::GetGlobalPreferences after OnContextInitialized is called. Global preferences are registered a single time at application startup. See related cef_settings_t.cache_path and cef_settings_t.persist_user_preferences configuration.

If |type| is CEF_PREFERENCES_TYPE_REQUEST_CONTEXT the preferences can be accessed via the CefRequestContext after CefRequestContextHandler::OnRequestContextInitialized is called. Request context preferences are registered each time a new CefRequestContext is created. It is intended but not required that all request contexts have the same registered preferences. See related cef_request_context_settings_t.cache_path and cef_request_context_settings_t.persist_user_preferences configuration.

Do not keep a reference to the |registrar| object. This method is called on the browser process UI thread.

OnScheduleMessagePumpWork()

virtual void CefBrowserProcessHandler::OnScheduleMessagePumpWork ( int64_t  delay_ms )

inlinevirtual

Called from any thread when work has been scheduled for the browser process main (UI) thread.

This callback is used in combination with cef_settings_t.external_message_pump and CefDoMessageLoopWork() in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CefDoMessageLoopWork). This callback should schedule a CefDoMessageLoopWork() call to happen on the main (UI) thread. |delay_ms| is the requested delay in milliseconds. If |delay_ms| is <= 0 then the call should happen reasonably soon. If |delay_ms| is > 0 then the call should be scheduled to happen after the specified delay and any currently pending scheduled call should be cancelled.

---

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

• include/cef_browser_process_handler.h