* soup_address_is_resolved() to safely test whether or not an address
* is resolved before fetching its name or address.
*
- * Return value: (allow-none): the sockaddr, or %NULL
+ * Return value: (allow-none) (transfer none): the sockaddr, or %NULL
**/
struct sockaddr *
soup_address_get_sockaddr (SoupAddress *addr, int *len)
* Creates a new #GSocketAddress corresponding to @addr (which is assumed
* to only have one socket address associated with it).
*
- * Return value: a new #GSocketAddress
+ * Return value: (transfer full): a new #GSocketAddress
*/
GSocketAddress *
soup_address_get_gsockaddr (SoupAddress *addr)
* of @auth's protection space, unless otherwise discovered not to
* be.)
*
- * Return value: (element-type utf8): the list of paths, which can be freed with
- * soup_auth_free_protection_space().
+ * Return value: (element-type utf8) (transfer full): the list of
+ * paths, which can be freed with soup_auth_free_protection_space().
**/
GSList *
soup_auth_get_protection_space (SoupAuth *auth, SoupURI *source_uri)
* The cookies in the list are a copy of the original, so
* you have to free them when you are done with them.
*
- * Return value: a #GSList with all the cookies in the @jar.
+ * Return value: (transfer full): a #GSList with all the cookies in
+ * the @jar.
*
* Since: 2.26
**/
* #SoupCookie<!-- -->s. Cookies that do not specify "path" or
* "domain" attributes will have their values defaulted from @msg.
*
- * Return value: (element-type SoupCookie): a #GSList of
- * #SoupCookie<!-- -->s, which can be freed with soup_cookies_free().
+ * Return value: (element-type SoupCookie) (transfer full): a #GSList
+ * of #SoupCookie<!-- -->s, which can be freed with
+ * soup_cookies_free().
*
* Since: 2.24
**/
* pass a cookie returned from this method directly to
* soup_cookies_to_response().)
*
- * Return value: (element-type SoupCookie): a #GSList of
- * #SoupCookie<!-- -->s, which can be freed with soup_cookies_free().
+ * Return value: (element-type SoupCookie) (transfer full): a #GSList
+ * of #SoupCookie<!-- -->s, which can be freed with
+ * soup_cookies_free().
*
* Since: 2.24
**/
* Decodes @form, which is an urlencoded dataset as defined in the
* HTML 4.01 spec.
*
- * Return value: (element-type utf8 utf8): a hash table containing the
- * name/value pairs from @encoded_form, which you can free with
- * g_hash_table_destroy().
+ * Return value: (element-type utf8 utf8) (transfer full): a hash
+ * table containing the name/value pairs from @encoded_form, which you
+ * can free with g_hash_table_destroy().
**/
GHashTable *
soup_form_decode (const char *encoded_form)
* soup_form_decode_multipart:
* @msg: a #SoupMessage containing a "multipart/form-data" request body
* @file_control_name: the name of the HTML file upload control, or %NULL
- * @filename: return location for the name of the uploaded file
- * @content_type: return location for the MIME type of the uploaded file
- * @file: return location for the uploaded file data
+ * @filename: (out): return location for the name of the uploaded file
+ * @content_type: (out): return location for the MIME type of the uploaded file
+ * @file: (out): return location for the uploaded file data
*
* Decodes the "multipart/form-data" request in @msg; this is a
* convenience method for the case when you have a single file upload
* need to decode it manually, using soup_multipart_new_from_message()
* and soup_multipart_get_part().
*
- * Return value: (element-type utf8 utf8): a hash table containing the
- * name/value pairs (other than @file_control_name) from @msg, which
- * you can free with g_hash_table_destroy(). On error, it will return
- * %NULL.
+ * Return value: (element-type utf8 utf8) (transfer full): a hash
+ * table containing the name/value pairs (other than
+ * @file_control_name) from @msg, which you can free with
+ * g_hash_table_destroy(). On error, it will return %NULL.
*
* Since: 2.26
**/
* the form data into @uri's query field, and if @method is "POST", it
* will encode it into the %SoupMessage's request_body.)
*
- * Return value: the new %SoupMessage
+ * Return value: (transfer full): the new %SoupMessage
**/
SoupMessage *
soup_form_request_new (const char *method, const char *uri,
* Creates a new %SoupMessage and sets it up to send @form_data_set to
* @uri via @method, as with soup_form_request_new().
*
- * Return value: the new %SoupMessage
+ * Return value: (transfer full): the new %SoupMessage
**/
SoupMessage *
soup_form_request_new_from_hash (const char *method, const char *uri,
* Creates a new %SoupMessage and sets it up to send @form_data_set to
* @uri via @method, as with soup_form_request_new().
*
- * Return value: the new %SoupMessage
+ * Return value: (transfer full): the new %SoupMessage
**/
SoupMessage *
soup_form_request_new_from_datalist (const char *method, const char *uri,
* soup_form_request_new_from_multipart() to serialize the multipart
* structure and create a #SoupMessage.
*
- * Return value: the new %SoupMessage
+ * Return value: (transfer full): the new %SoupMessage
*
* Since: 2.26
**/
* "#something", where "something" does not itself contain commas,
* except as part of quoted-strings.
*
- * Return value: a #GSList of list elements, as allocated strings
+ * Return value: (transfer full): a #GSList of list elements, as
+ * allocated strings
**/
GSList *
soup_header_parse_list (const char *header)
/**
* soup_header_parse_quality_list:
* @header: a header value
- * @unacceptable: (out) (allow-none): on return, will contain a list of
- * unacceptable values
+ * @unacceptable: (out) (allow-none) (transfer full): on return, will
+ * contain a list of unacceptable values
*
* Parses a header whose content is a list of items with optional
* "qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding,
* items with qvalue 0. Either way, those items will be removed from
* the main list.
*
- * Return value: a #GSList of acceptable values (as allocated
- * strings), highest-qvalue first.
+ * Return value: (transfer full): a #GSList of acceptable values (as
+ * allocated strings), highest-qvalue first.
**/
GSList *
soup_header_parse_quality_list (const char *header, GSList **unacceptable)
}
/**
- * soup_header_free_list:
+ * soup_header_free_list: (skip)
* @list: a #GSList returned from soup_header_parse_list() or
* soup_header_parse_quality_list()
*
* for giving UTF8-encoded filenames in the Content-Disposition
* header).
*
- * Return value: (element-type utf8 utf8): a #GHashTable of list elements, which can be freed
- * with soup_header_free_param_list().
+ * Return value: (element-type utf8 utf8) (transfer full): a
+ * #GHashTable of list elements, which can be freed with
+ * soup_header_free_param_list().
**/
GHashTable *
soup_header_parse_param_list (const char *header)
* for giving UTF8-encoded filenames in the Content-Disposition
* header).
*
- * Return value: (element-type utf8 utf8): a #GHashTable of list
- * elements, which can be freed with soup_header_free_param_list().
+ * Return value: (element-type utf8 utf8) (transfer full): a
+ * #GHashTable of list elements, which can be freed with
+ * soup_header_free_param_list().
*
* Since: 2.24
**/
/**
* SoupBuffer:
- * @data: (type pointer): the data
+ * @data: (type gpointer): the data
* @length: length of @data
*
* A data buffer, generally used to represent a chunk of a
* Gets the "owner" object for a buffer created with
* soup_buffer_new_with_owner().
*
- * Return value: the owner pointer
+ * Return value: (transfer none): the owner pointer
**/
gpointer
soup_buffer_get_owner (SoupBuffer *buffer)
* soup_message_body_append:
* @body: a #SoupMessageBody
* @use: how to use @data
- * @data: (array length=length) (element-type uint8): data to append
+ * @data: (array length=length) (element-type guint8): data to append
* @length: length of @data
*
* Appends @length bytes from @data to @body according to @use.
/**
* soup_message_headers_foreach:
* @hdrs: a #SoupMessageHeaders
- * @func: callback function to run for each header
+ * @func: (scope call): callback function to run for each header
* @user_data: data to pass to @func
*
* Calls @func once for each header value in @hdrs.
* @msg: the message
* @content_type: (allow-none): MIME Content-Type of the body
* @resp_use: a #SoupMemoryUse describing how to handle @resp_body
- * @resp_body: (array length=resp_length) (element-type uint8): a data buffer
+ * @resp_body: (array length=resp_length) (element-type guint8): a data buffer
* containing the body of the message response.
* @resp_length: the byte length of @resp_body.
*
*
* Gets the #SoupAuth used by @msg for authentication.
*
- * Return value: the #SoupAuth used by @msg for authentication, or
- * %NULL if @msg is unauthenticated.
+ * Return value: (transfer none): the #SoupAuth used by @msg for
+ * authentication, or %NULL if @msg is unauthenticated.
**/
SoupAuth *
soup_message_get_auth (SoupMessage *msg)
}
/**
- * soup_add_io_watch:
+ * soup_add_io_watch: (skip)
* @async_context: (allow-none): the #GMainContext to dispatch the I/O
* watch in, or %NULL for the default context
* @chan: the #GIOChannel to watch
}
/**
- * soup_add_idle:
+ * soup_add_idle: (skip)
* @async_context: (allow-none): the #GMainContext to dispatch the I/O
* watch in, or %NULL for the default context
* @function: the callback to invoke at idle time
}
/**
- * soup_add_completion:
+ * soup_add_completion: (skip)
* @async_context: (allow-none): the #GMainContext to dispatch the I/O
* watch in, or %NULL for the default context
* @function: the callback to invoke
}
/**
- * soup_add_timeout:
+ * soup_add_timeout: (skip)
* @async_context: (allow-none): the #GMainContext to dispatch the I/O
* watch in, or %NULL for the default context
* @interval: the timeout interval, in milliseconds
GTypeInterface base;
/* virtual methods */
- void (*get_proxy_async) (SoupProxyResolver *, SoupMessage *,
- GMainContext *, GCancellable *,
- SoupProxyResolverCallback, gpointer);
- guint (*get_proxy_sync) (SoupProxyResolver *, SoupMessage *,
- GCancellable *, SoupAddress **);
+ void (*get_proxy_async) (SoupProxyResolver *proxy_resolver,
+ SoupMessage *msg, GMainContext *async_context,
+ GCancellable *cancellable,
+ SoupProxyResolverCallback callaback,
+ gpointer user_data);
+ guint (*get_proxy_sync) (SoupProxyResolver *proxy_resolver,
+ SoupMessage *msg, GCancellable *cancellable,
+ SoupAddress **addr);
} SoupProxyResolverInterface;
* @uri: the #SoupURI you want a proxy for
* @async_context: (allow-none): the #GMainContext to invoke @callback in
* @cancellable: a #GCancellable, or %NULL
- * @callback: callback to invoke with the proxy address
+ * @callback: (scope async): callback to invoke with the proxy address
* @user_data: data for @callback
*
* Asynchronously determines a proxy URI to use for @msg and calls
GTypeInterface base;
/* virtual methods */
- void (*get_proxy_uri_async) (SoupProxyURIResolver *, SoupURI *,
- GMainContext *, GCancellable *,
- SoupProxyURIResolverCallback, gpointer);
- guint (*get_proxy_uri_sync) (SoupProxyURIResolver *, SoupURI *,
- GCancellable *, SoupURI **);
+ void (*get_proxy_uri_async) (SoupProxyURIResolver *proxy_uri_resolver,
+ SoupURI *uri, GMainContext *async_context,
+ GCancellable *cancellable,
+ SoupProxyURIResolverCallback callback,
+ gpointer user_data);
+ guint (*get_proxy_uri_sync) (SoupProxyURIResolver *proxy_uri_resolver,
+ SoupURI *uri, GCancellable *cancellable,
+ SoupURI **proxy_uri);
/* Padding for future expansion */
void (*_libsoup_reserved1) (void);
* Creates a #GHashTable whose keys are strings and whose values
* are #GValue.
*
- * Return value: (element-type utf8 GValue): a new empty #GHashTable
+ * Return value: (element-type utf8 GValue) (transfer full): a new
+ * empty #GHashTable
**/
GHashTable *
soup_value_hash_new (void)
* with soup_value_hash_insert(), the keys and values are copied
* rather than being inserted directly.
*
- * Return value: (element-type utf8 GValue): a new #GHashTable, initialized with the given values
+ * Return value: (element-type utf8 GValue) (transfer full): a new
+ * #GHashTable, initialized with the given values
**/
GHashTable *
soup_value_hash_new_with_vals (const char *first_key, ...)
* and then a value of the appropriate type, finally terminated by
* %G_TYPE_INVALID.
*
- * Return value: a #SoupMessage encoding the indicated XML-RPC
- * request.
+ * Return value: (transfer full): a #SoupMessage encoding the
+ * indicated XML-RPC request.
**/
SoupMessage *
soup_xmlrpc_request_new (const char *uri, const char *method_name, ...)