diff options
author | Timm Bäder <mail@baedert.org> | 2016-07-18 10:35:33 +0200 |
---|---|---|
committer | Timm Bäder <mail@baedert.org> | 2016-07-19 14:01:22 +0200 |
commit | d300e04ff3a381e1a4425de165b2e7ac324b31ff (patch) | |
tree | 567a7411341a7ba0150b280da569f5287822a72a | |
parent | 80efc320417c988cc09df25c18ba435f84b7b6bb (diff) | |
download | librest-d300e04ff3a381e1a4425de165b2e7ac324b31ff.tar.gz |
RestProxyCall: Add documentation for _sync
-rw-r--r-- | rest/rest-proxy-call.c | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c index 9384b5b..348b7f2 100644 --- a/rest/rest-proxy-call.c +++ b/rest/rest-proxy-call.c @@ -1212,9 +1212,23 @@ rest_proxy_call_cancel (RestProxyCall *call) return TRUE; } +/** + * rest_proxy_call_sync: + * @call: a #RestProxycall + * @error_out: a #GError or %NULL + * + * Synchronously invokes @call. After this function has returned, + * rest_proxy_call_get_payload() will return the result of this call. + * + * Note that this will block an undefined amount of time, so + * rest_proxy_call_invoke_async() is generally recommended. + * + * Returns: %TRUE on success, %FALSE if a failure occurred, + * in which case @error_out will be set. + */ gboolean -rest_proxy_call_sync (RestProxyCall *call, - GError **error_out) +rest_proxy_call_sync (RestProxyCall *call, + GError **error_out) { RestProxyCallPrivate *priv = GET_PRIVATE (call); SoupMessage *message; |