-// Copyright (c) 2014 Marshall A. Greenblatt. All rights reserved.
+// Copyright (c) 2017 Marshall A. Greenblatt. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
#endif
struct _cef_cookie_visitor_t;
+struct _cef_delete_cookies_callback_t;
+struct _cef_set_cookie_callback_t;
///
// Structure used for managing cookies. The functions of this structure may be
///
// Base structure.
///
- cef_base_t base;
+ cef_base_ref_counted_t base;
///
- // Set the schemes supported by this manager. By default only "http" and
- // "https" schemes are supported. Must be called before any cookies are
- // accessed.
+ // Set the schemes supported by this manager. The default schemes ("http",
+ // "https", "ws" and "wss") will always be supported. If |callback| is non-
+ // NULL it will be executed asnychronously on the IO thread after the change
+ // has been applied. Must be called before any cookies are accessed.
///
void (CEF_CALLBACK *set_supported_schemes)(struct _cef_cookie_manager_t* self,
- cef_string_list_t schemes);
+ cef_string_list_t schemes, struct _cef_completion_callback_t* callback);
///
- // Visit all cookies. The returned cookies are ordered by longest path, then
- // by earliest creation date. Returns false (0) if cookies cannot be accessed.
+ // Visit all cookies on the IO thread. The returned cookies are ordered by
+ // longest path, then by earliest creation date. Returns false (0) if cookies
+ // cannot be accessed.
///
int (CEF_CALLBACK *visit_all_cookies)(struct _cef_cookie_manager_t* self,
struct _cef_cookie_visitor_t* visitor);
///
- // Visit a subset of cookies. The results are filtered by the given url
- // scheme, host, domain and path. If |includeHttpOnly| is true (1) HTTP-only
- // cookies will also be included in the results. The returned cookies are
- // ordered by longest path, then by earliest creation date. Returns false (0)
- // if cookies cannot be accessed.
+ // Visit a subset of cookies on the IO thread. The results are filtered by the
+ // given url scheme, host, domain and path. If |includeHttpOnly| is true (1)
+ // HTTP-only cookies will also be included in the results. The returned
+ // cookies are ordered by longest path, then by earliest creation date.
+ // Returns false (0) if cookies cannot be accessed.
///
int (CEF_CALLBACK *visit_url_cookies)(struct _cef_cookie_manager_t* self,
const cef_string_t* url, int includeHttpOnly,
// Sets a cookie given a valid URL and explicit user-provided cookie
// attributes. This function expects each attribute to be well-formed. It will
// check for disallowed characters (e.g. the ';' character is disallowed
- // within the cookie value attribute) and will return false (0) without
- // setting the cookie if such characters are found. This function must be
- // called on the IO thread.
+ // within the cookie value attribute) and fail without setting the cookie if
+ // such characters are found. If |callback| is non-NULL it will be executed
+ // asnychronously on the IO thread after the cookie has been set. Returns
+ // false (0) if an invalid URL is specified or if cookies cannot be accessed.
///
int (CEF_CALLBACK *set_cookie)(struct _cef_cookie_manager_t* self,
- const cef_string_t* url, const struct _cef_cookie_t* cookie);
+ const cef_string_t* url, const struct _cef_cookie_t* cookie,
+ struct _cef_set_cookie_callback_t* callback);
///
// Delete all cookies that match the specified parameters. If both |url| and
- // values |cookie_name| are specified all host and domain cookies matching
+ // |cookie_name| values are specified all host and domain cookies matching
// both will be deleted. If only |url| is specified all host cookies (but not
// domain cookies) irrespective of path will be deleted. If |url| is NULL all
- // cookies for all hosts and domains will be deleted. Returns false (0) if a
- // non- NULL invalid URL is specified or if cookies cannot be accessed. This
- // function must be called on the IO thread.
+ // cookies for all hosts and domains will be deleted. If |callback| is non-
+ // NULL it will be executed asnychronously on the IO thread after the cookies
+ // have been deleted. Returns false (0) if a non-NULL invalid URL is specified
+ // or if cookies cannot be accessed. Cookies can alternately be deleted using
+ // the Visit*Cookies() functions.
///
int (CEF_CALLBACK *delete_cookies)(struct _cef_cookie_manager_t* self,
- const cef_string_t* url, const cef_string_t* cookie_name);
+ const cef_string_t* url, const cef_string_t* cookie_name,
+ struct _cef_delete_cookies_callback_t* callback);
///
// Sets the directory path that will be used for storing cookie data. If
// stored at the specified |path|. To persist session cookies (cookies without
// an expiry date or validity interval) set |persist_session_cookies| to true
// (1). Session cookies are generally intended to be transient and most Web
- // browsers do not persist them. Returns false (0) if cookies cannot be
- // accessed.
+ // browsers do not persist them. If |callback| is non-NULL it will be executed
+ // asnychronously on the IO thread after the manager's storage has been
+ // initialized. Returns false (0) if cookies cannot be accessed.
///
int (CEF_CALLBACK *set_storage_path)(struct _cef_cookie_manager_t* self,
- const cef_string_t* path, int persist_session_cookies);
+ const cef_string_t* path, int persist_session_cookies,
+ struct _cef_completion_callback_t* callback);
///
- // Flush the backing store (if any) to disk and execute the specified
- // |handler| on the IO thread when done. Returns false (0) if cookies cannot
- // be accessed.
+ // Flush the backing store (if any) to disk. If |callback| is non-NULL it will
+ // be executed asnychronously on the IO thread after the flush is complete.
+ // Returns false (0) if cookies cannot be accessed.
///
int (CEF_CALLBACK *flush_store)(struct _cef_cookie_manager_t* self,
- struct _cef_completion_handler_t* handler);
+ struct _cef_completion_callback_t* callback);
} cef_cookie_manager_t;
///
// Returns the global cookie manager. By default data will be stored at
-// CefSettings.cache_path if specified or in memory otherwise.
+// CefSettings.cache_path if specified or in memory otherwise. If |callback| is
+// non-NULL it will be executed asnychronously on the IO thread after the
+// manager's storage has been initialized. Using this function is equivalent to
+// calling cef_request_tContext::cef_request_context_get_global_context()->get_d
+// efault_cookie_manager().
///
-CEF_EXPORT cef_cookie_manager_t* cef_cookie_manager_get_global_manager();
+CEF_EXPORT cef_cookie_manager_t* cef_cookie_manager_get_global_manager(
+ struct _cef_completion_callback_t* callback);
///
// Creates a new cookie manager. If |path| is NULL data will be stored in memory
// only. Otherwise, data will be stored at the specified |path|. To persist
// session cookies (cookies without an expiry date or validity interval) set
// |persist_session_cookies| to true (1). Session cookies are generally intended
-// to be transient and most Web browsers do not persist them. Returns NULL if
-// creation fails.
+// to be transient and most Web browsers do not persist them. If |callback| is
+// non-NULL it will be executed asnychronously on the IO thread after the
+// manager's storage has been initialized.
///
CEF_EXPORT cef_cookie_manager_t* cef_cookie_manager_create_manager(
- const cef_string_t* path, int persist_session_cookies);
+ const cef_string_t* path, int persist_session_cookies,
+ struct _cef_completion_callback_t* callback);
///
///
// Base structure.
///
- cef_base_t base;
+ cef_base_ref_counted_t base;
///
// Method that will be called once for each cookie. |count| is the 0-based
} cef_cookie_visitor_t;
+///
+// Structure to implement to be notified of asynchronous completion via
+// cef_cookie_manager_t::set_cookie().
+///
+typedef struct _cef_set_cookie_callback_t {
+ ///
+ // Base structure.
+ ///
+ cef_base_ref_counted_t base;
+
+ ///
+ // Method that will be called upon completion. |success| will be true (1) if
+ // the cookie was set successfully.
+ ///
+ void (CEF_CALLBACK *on_complete)(struct _cef_set_cookie_callback_t* self,
+ int success);
+} cef_set_cookie_callback_t;
+
+
+///
+// Structure to implement to be notified of asynchronous completion via
+// cef_cookie_manager_t::delete_cookies().
+///
+typedef struct _cef_delete_cookies_callback_t {
+ ///
+ // Base structure.
+ ///
+ cef_base_ref_counted_t base;
+
+ ///
+ // Method that will be called upon completion. |num_deleted| will be the
+ // number of cookies that were deleted or -1 if unknown.
+ ///
+ void (CEF_CALLBACK *on_complete)(struct _cef_delete_cookies_callback_t* self,
+ int num_deleted);
+} cef_delete_cookies_callback_t;
+
+
#ifdef __cplusplus
}
#endif
projects / casparcg / blobdiff