Click or drag to resize
CfxRequestContext Class

[This is preliminary documentation and is subject to change.]

A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser via the CfxBrowserHost static factory functions or when creating a new URL request via the CfxUrlRequest static factory functions. Browser objects with different request contexts will never be hosted in the same render process. Browser objects with the same request context may or may not be hosted in the same render process depending on the process model. Browser objects created indirectly via the JavaScript window.open function or targeted links will share the same render process and the same request context as the source browser. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into a CfxBrowserHost static factory function and all other request context objects will be ignored.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxLibraryBase
        ChromiumCfxRequestContext

Namespace: Chromium
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxRequestContext : CfxLibraryBase

The CfxRequestContext type exposes the following members.

Properties
  NameDescription
Public propertyCachePath
Returns the cache path for this object. If NULL an "incognito mode" in- memory cache is being used.
Public propertyHandler
Returns the handler for this context if any.
Public propertyIsGlobal
Returns true (1) if this object is the global context. The global context is used by default when creating a browser or URL request with a NULL context argument.
Public propertyNativePtr
Provides access to the underlying native cef struct. This is a refcounted library struct derived from cef_base_t. Add a ref in order to keep it alive when this managed object go out of scope.
(Inherited from CfxLibraryBase.)
Top
Methods
  NameDescription
Public methodCanSetPreference
Returns true (1) if the preference with the specified |name| can be modified using SetPreference. As one example preferences set via the command-line usually cannot be modified. This function must be called on the browser process UI thread.
Public methodClearCertificateExceptions
Clears all certificate exceptions that were added as part of handling CfxRequestHandler.OnCertificateError(). If you call this it is recommended that you also call close_all_connections() or you risk not being prompted again for server certificates if you reconnect quickly. If |callback| is non-NULL it will be executed on the UI thread after completion.
Public methodClearSchemeHandlerFactories
Clear all registered scheme handler factories. Returns false (0) on error. This function may be called on any thread in the browser process.
Public methodCloseAllConnections
Clears all active and idle connections that Chromium currently has. This is only recommended if you have released all other CEF objects but don't yet want to call cef_shutdown(). If |callback| is non-NULL it will be executed on the UI thread after completion.
Public methodStatic memberCreateContext
Creates a new context object with the specified |settings| and optional |handler|.
Public methodGetAllPreferences
Returns all preferences as a dictionary. If |includeDefaults| is true (1) then preferences currently at their default value will be included. The returned object contains a copy of the underlying preference values and modifications to the returned object will not modify the underlying preference values. This function must be called on the browser process UI thread.
Public methodGetDefaultCookieManager
Returns the default cookie manager for this object. This will be the global cookie manager if this object is the global request context. Otherwise, this will be the default cookie manager used when this request context does not receive a value via CfxRequestContextHandler.GetCookieManager(). If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized.
Public methodStatic memberGetGlobalContext
Returns the global context object.
Public methodGetPreference
Returns the value for the preference with the specified |name|. Returns NULL if the preference does not exist. The returned object contains a copy of the underlying preference value and modifications to the returned object will not modify the underlying preference value. This function must be called on the browser process UI thread.
Public methodHasPreference
Returns true (1) if a preference with the specified |name| exists. This function must be called on the browser process UI thread.
Public methodIsSame
Returns true (1) if this object is pointing to the same context as |that| object.
Public methodIsSharingWith
Returns true (1) if this object is sharing the same storage as |that| object.
Public methodPurgePluginListCache
Tells all renderer processes associated with this context to throw away their plugin list cache. If |reloadPages| is true (1) they will also reload all pages with plugins. CfxRequestContextHandler.OnBeforePluginLoad may be called to rebuild the plugin list cache.
Public methodRegisterSchemeHandlerFactory
Register a scheme handler factory for the specified |schemeName| and optional |domainName|. An NULL |domainName| value for a standard scheme will cause the factory to match all domain names. The |domainName| value will be ignored for non-standard schemes. If |schemeName| is a built-in scheme and no handler is returned by |factory| then the built-in scheme handler factory will be called. If |schemeName| is a custom scheme then you must also implement the CfxApp.OnRegisterCustomSchemes() function in all processes. This function may be called multiple times to change or remove the factory that matches the specified |schemeName| and optional |domainName|. Returns false (0) if an error occurs. This function may be called on any thread in the browser process.
Public methodResolveHost
Attempts to resolve |origin| to a list of associated IP addresses. |callback| will be executed on the UI thread after completion.
Public methodResolveHostCached
Attempts to resolve |origin| to a list of associated IP addresses using cached data. |resolvedIps| will be populated with the list of resolved IP addresses or NULL if no cached data is available. Returns ERR_NONE on success. This function must be called on the browser process IO thread.
Public methodSetPreference
Set the |value| associated with preference |name|. Returns true (1) if the value is set successfully and false (0) otherwise. If |value| is NULL the preference will be restored to its default value. If setting the preference fails then |error| will be populated with a detailed description of the problem. This function must be called on the browser process UI thread.
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.
See Also