fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-08 23:30:18 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

cloud-setup: add gtk-doc comment for nm_http_client_get_finish()

Browse source 
NMHttpClient guarantees that the returned response is %NUL terminated after the
returned length of the buffer. That guarantee is important and should be documented.
This commit is contained in:
Thomas Haller 2020-06-29 09:52:28 +02:00
parent 460afe6d50
commit e3bbd267c3
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
clients/cloud-setup/nm-http-client.c
View file

@ -351,6 +351,21 @@ nm_http_client_get (NMHttpClient *self,
}
}
/**
* nm_http_client_get_finish:
* @self: the #NMHttpClient instance
* @result: the #GAsyncResult which to complete.
* @out_response_code: (allow-none) (out): the HTTP response code or -1 on other error.
* @out_response_data: (allow-none) (transfer full): the HTTP response data, if any.
* The GBytes buffer is guaranteed to have a trailing NUL character *after* the
* returned buffer size. That means, you can always trust that the buffer is NUL terminated
* and that there is one additional hidden byte after the data.
* Also, the returned buffer is allocated just for you. While GBytes is immutable, you are
* allowed to modify the buffer as it's not used by anybody else.
* @error: the error
*
* Returns: %TRUE on success.
*/
gboolean
nm_http_client_get_finish (NMHttpClient *self,
GAsyncResult *result,