luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gsocket: Clarify in docs that flags arguments can be platform specific

Browse Source 
As suggested by Philip Chimento.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall 2019-03-16 16:01:58 +00:00
parent 8482318208
commit e9389efe5b
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gio/gsocket.c
View File

@ -4540,7 +4540,8 @@ input_message_from_msghdr (const struct msghdr *msg,
* @messages: (array length=num_messages) (nullable): a pointer to an * @messages: (array length=num_messages) (nullable): a pointer to an
* array of #GSocketControlMessages, or %NULL. * array of #GSocketControlMessages, or %NULL.
* @num_messages: number of elements in @messages, or -1. * @num_messages: number of elements in @messages, or -1.
* @flags: an int containing #GSocketMsgFlags flags * @flags: an int containing #GSocketMsgFlags flags, which may additionally
* contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)
* @cancellable: (nullable): a %GCancellable or %NULL * @cancellable: (nullable): a %GCancellable or %NULL
* @error: #GError for error reporting, or %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore.
* *
@ -4629,7 +4630,8 @@ g_socket_send_message (GSocket *socket,
* @messages: (array length=num_messages) (nullable): a pointer to an * @messages: (array length=num_messages) (nullable): a pointer to an
* array of #GSocketControlMessages, or %NULL. * array of #GSocketControlMessages, or %NULL.
* @num_messages: number of elements in @messages, or -1. * @num_messages: number of elements in @messages, or -1.
* @flags: an int containing #GSocketMsgFlags flags * @flags: an int containing #GSocketMsgFlags flags, which may additionally
* contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)
* @timeout_us: the maximum time (in microseconds) to wait, or -1 * @timeout_us: the maximum time (in microseconds) to wait, or -1
* @bytes_written: (out) (optional): location to store the number of bytes that were written to the socket * @bytes_written: (out) (optional): location to store the number of bytes that were written to the socket
* @cancellable: (nullable): a %GCancellable or %NULL * @cancellable: (nullable): a %GCancellable or %NULL
@ -4862,7 +4864,8 @@ g_socket_send_message_with_timeout (GSocket *socket,
* @socket: a #GSocket * @socket: a #GSocket
* @messages: (array length=num_messages): an array of #GOutputMessage structs * @messages: (array length=num_messages): an array of #GOutputMessage structs
* @num_messages: the number of elements in @messages * @num_messages: the number of elements in @messages
* @flags: an int containing #GSocketMsgFlags flags * @flags: an int containing #GSocketMsgFlags flags, which may additionally
* contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)
* @cancellable: (nullable): a %GCancellable or %NULL * @cancellable: (nullable): a %GCancellable or %NULL
* @error: #GError for error reporting, or %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore.
* *
@ -5362,7 +5365,9 @@ g_socket_receive_message_with_timeout (GSocket *socket,
* @socket: a #GSocket * @socket: a #GSocket
* @messages: (array length=num_messages): an array of #GInputMessage structs * @messages: (array length=num_messages): an array of #GInputMessage structs
* @num_messages: the number of elements in @messages * @num_messages: the number of elements in @messages
* @flags: an int containing #GSocketMsgFlags flags for the overall operation * @flags: an int containing #GSocketMsgFlags flags for the overall operation,
* which may additionally contain
* [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)
* @cancellable: (nullable): a %GCancellable or %NULL * @cancellable: (nullable): a %GCancellable or %NULL
* @error: #GError for error reporting, or %NULL to ignore * @error: #GError for error reporting, or %NULL to ignore
* *
@ -5648,7 +5653,9 @@ g_socket_receive_messages_with_timeout (GSocket *socket,
* which may be filled with an array of #GSocketControlMessages, or %NULL * which may be filled with an array of #GSocketControlMessages, or %NULL
* @num_messages: (out): a pointer which will be filled with the number of * @num_messages: (out): a pointer which will be filled with the number of
* elements in @messages, or %NULL * elements in @messages, or %NULL
* @flags: (inout): a pointer to an int containing #GSocketMsgFlags flags * @flags: (inout): a pointer to an int containing #GSocketMsgFlags flags,
* which may additionally contain
* [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)
* @cancellable: a %GCancellable or %NULL * @cancellable: a %GCancellable or %NULL
* @error: a #GError pointer, or %NULL * @error: a #GError pointer, or %NULL
* *