|
Options |
Name |
Purpose |
|
|
|
AddCookie (character, character, Cookie)
|
/** Adds a cookie to the jar, for a given domain/path.
Do not save bad cookies:
- that do not have matching domains
- that are too broad in scope
@param character The domain to which this cookie applies
@param character The path to which this cookie applies
@param Cookie The cookie to add */
|
|
|
|
AddCookie (Cookie)
|
/** Adds a single cookie to the jar (and persists, if needed).
@param character A cookie string as received from the HTTP response. */
|
|
|
|
AddCookies (Cookie[])
|
/** Adds a collection of cookies to the jar.
@param Cookie The cookies to add */
|
|
|
|
INTEGER CheckCookie (URI, Cookie)
|
/** Checks whether a cookie is valid for a URI
@param URI The uri for which to retrieve cookies
@param Cookie The cookie to check
@return integer 1: cookie matches URI
0: cookie does not match URI
-1: cookie matches URI and has expired */
|
|
|
|
ClearPersistentCookies ()
|
/** Clears all persistent cookies */
|
|
|
|
ClearSessionCookies ()
|
/** Clears all session cookies */
|
|
|
|
LOGICAL DeleteCookie (handle, Cookie)
|
/** Removes a persistent cookie that corresponds to a session cookie.
@param handle The buffer handle for the temp-table store
@param Cookie The cookie to add into the store.
@return logical True if the cookie was deleted from the store. */
|
|
|
|
Destroy ()
|
/* Destroy/Shutdown/Anti-Initializer */
|
|
|
|
INTEGER GetCookies (URI, Cookie[])
|
/** Returns a set of cookies for a given URI.
Algorithm from finding relevant cookies derived from
https://tools.ietf.org/html/rfc6265#page-25 (section 5.4)
@param URI The host/URI for which to return the cookies.
@param Cookie[] Output array of the cookies
@return integer The number of cookies returned */
|
|
|
|
Initialize ()
|
/* Initializer/Startup */
|
|
|
|
LoadCookieJar (character)
|
/** Loads the cookie jar with persisted cookies, from disk.
@param character The JOSN file in which the cookies are persisted. */
|
|
|
|
PersistCookieJar (character)
|
/** Persists - to disk - the current set of persistent cookies */
|
|
|
|
PutCookie (handle, character, character, Cookie)
|
/** Helper method for creating cookies in the relevant store (session or persistent).
@param handle The buffer handle for the temp-table store
@param character The domain to which this cookie applies
@param character The path to which this cookie applies
@param Cookie The cookie to add into the store. */
|
|
|
|
LOGICAL RemoveCookie (Cookie)
|
/** Removes a cookie from the jar.
@param Cookie The cookie to remove
@return logical True if the cookie was deleted. */
|