Struct

SoupCookie

Description [src]

struct SoupCookie {
  /* No available fields */
}

Implements HTTP cookies, as described by RFC 6265.

To have a SoupSession handle cookies for your appliction automatically, use a SoupCookieJar.

name and value will be set for all cookies. If the cookie is generated from a string that appears to have no name, then name will be the empty string.

domain and path give the host or domain, and path within that host/domain, to restrict this cookie to. If domain starts with “.”, that indicates a domain (which matches the string after the “.”, or any hostname that has domain as a suffix). Otherwise, it is a hostname and must match exactly.

expires will be non-NULL if the cookie uses either the original “expires” attribute, or the newer “max-age” attribute. If expires is NULL, it indicates that neither “expires” nor “max-age” was specified, and the cookie expires at the end of the session.

If http_only is set, the cookie should not be exposed to untrusted code (eg, javascript), so as to minimize the danger posed by cross-site scripting attacks.

Constructors

soup_cookie_new

Creates a new SoupCookie with the given attributes.

Functions

soup_cookie_parse

Parses header and returns a SoupCookie.

Instance methods

soup_cookie_applies_to_uri

Tests if cookie should be sent to uri.

soup_cookie_copy

Copies cookie.

soup_cookie_domain_matches

Checks if the cookies domain and host match.

soup_cookie_equal

Tests if cookie1 and cookie2 are equal.

soup_cookie_free

Frees cookie.

soup_cookie_get_domain

Gets cookies domain.

soup_cookie_get_expires

Gets cookies expiration time.

soup_cookie_get_http_only

Gets cookies HttpOnly attribute.

soup_cookie_get_name

Gets cookies name.

soup_cookie_get_path

Gets cookies path.

soup_cookie_get_same_site_policy

Returns the same-site policy for this cookie.

soup_cookie_get_secure

Gets cookies secure attribute.

soup_cookie_get_value

Gets cookies value.

soup_cookie_set_domain

Sets cookies domain to domain.

soup_cookie_set_expires

Sets cookies expiration time to expires.

soup_cookie_set_http_only

Sets cookies HttpOnly attribute to http_only.

soup_cookie_set_max_age

Sets cookies max age to max_age.

soup_cookie_set_name

Sets cookies name to name.

soup_cookie_set_path

Sets cookies path to path.

soup_cookie_set_same_site_policy

When used in conjunction with soup_cookie_jar_get_cookie_list_with_same_site_info() this sets the policy of when this cookie should be exposed.

soup_cookie_set_secure

Sets cookies secure attribute to secure.

soup_cookie_set_value

Sets cookies value to value.

soup_cookie_to_cookie_header

Serializes cookie in the format used by the Cookie header (ie, for returning a cookie from a SoupSession to a server).

soup_cookie_to_set_cookie_header

Serializes cookie in the format used by the Set-Cookie header.