|  |  |  | libsoup Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ||||
| SoupCookieJarSoupCookieJar — Automatic cookie handling for SoupSession | 
SoupCookieJar; SoupCookieJar * soup_cookie_jar_new (void); void soup_cookie_jar_save (SoupCookieJar *jar); char * soup_cookie_jar_get_cookies (SoupCookieJar *jar, SoupURI *uri, gboolean for_http); void soup_cookie_jar_set_cookie (SoupCookieJar *jar, SoupURI *uri, const char *cookie); void soup_cookie_jar_add_cookie (SoupCookieJar *jar, SoupCookie *cookie); void soup_cookie_jar_delete_cookie (SoupCookieJar *jar, SoupCookie *cookie); GSList * soup_cookie_jar_all_cookies (SoupCookieJar *jar); #define SOUP_COOKIE_JAR_READ_ONLY
A SoupCookieJar stores SoupCookies and arrange for them
to be sent with the appropriate SoupMessages.
SoupCookieJar implements SoupSessionFeature, so you can add a
cookie jar to a session with soup_session_add_feature() or
soup_session_add_feature_by_type().
Note that the base SoupCookieJar class does not support any form of long-term cookie persistence.
SoupCookieJar * soup_cookie_jar_new (void);
Creates a new SoupCookieJar. The base SoupCookieJar class does not support persistent storage of cookies; use a subclass for that.
| Returns : | a new SoupCookieJar | 
Since 2.24
void soup_cookie_jar_save (SoupCookieJar *jar);
soup_cookie_jar_save is deprecated and should not be used in newly-written code.
| 
 | 
char * soup_cookie_jar_get_cookies (SoupCookieJar *jar, SoupURI *uri, gboolean for_http);
Retrieves (in Cookie-header form) the list of cookies that would
be sent with a request to uri.
If for_http is TRUE, the return value will include cookies marked
"HttpOnly" (that is, cookies that the server wishes to keep hidden
from client-side scripting operations such as the JavaScript
document.cookies property). Since SoupCookieJar sets the Cookie
header itself when making the actual HTTP request, you should
almost certainly be setting for_http to FALSE if you are calling
this.
| 
 | a SoupCookieJar | 
| 
 | a SoupURI | 
| 
 | whether or not the return value is being passed directly to an HTTP operation | 
| Returns : | the cookies, in string form, or NULLif there are no
cookies foruri. | 
Since 2.24
void soup_cookie_jar_set_cookie (SoupCookieJar *jar, SoupURI *uri, const char *cookie);
Adds cookie to jar, exactly as though it had appeared in a
Set-Cookie header returned from a request to uri.
| 
 | a SoupCookieJar | 
| 
 | the URI setting the cookie | 
| 
 | the stringified cookie to set | 
Since 2.24
void soup_cookie_jar_add_cookie (SoupCookieJar *jar, SoupCookie *cookie);
Adds cookie to jar, emitting the 'changed' signal if we are modifying
an existing cookie or adding a valid new cookie ('valid' means
that the cookie's expire date is not in the past).
cookie will be 'stolen' by the jar, so don't free it afterwards.
| 
 | a SoupCookieJar | 
| 
 | a SoupCookie | 
Since 2.26
void soup_cookie_jar_delete_cookie (SoupCookieJar *jar, SoupCookie *cookie);
Deletes cookie from jar, emitting the 'changed' signal.
| 
 | a SoupCookieJar | 
| 
 | a SoupCookie | 
Since 2.26
GSList * soup_cookie_jar_all_cookies (SoupCookieJar *jar);
Constructs a GSList with every cookie inside the jar.
The cookies in the list are a copy of the original, so
you have to free them when you are done with them.
| 
 | a SoupCookieJar | 
| Returns : | a GSList with all the cookies in the jar. | 
Since 2.26
#define SOUP_COOKIE_JAR_READ_ONLY "read-only"
Alias for the "read-only" property. (Whether or not the cookie jar is read-only.)
"changed" signalvoid user_function (SoupCookieJar *jar, SoupCookie *old_cookie, SoupCookie *new_cookie, gpointer user_data) : Run First
Emitted when jar changes. If a cookie has been added,
new_cookie will contain the newly-added cookie and
old_cookie will be NULL. If a cookie has been deleted,
old_cookie will contain the to-be-deleted cookie and
new_cookie will be NULL. If a cookie has been changed,
old_cookie will contain its old value, and new_cookie its
new value.
| 
 | the SoupCookieJar | 
| 
 | the old SoupCookie value | 
| 
 | the new SoupCookie value | 
| 
 | user data set when the signal handler was connected. |