[glib] gsocket: Clarify flags documentation for g_socket_receive_message()



commit 8fdc6701889679d16ac064b481f968807eddbf0f
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Mon Jul 27 14:46:54 2015 +0100

    gsocket: Clarify flags documentation for g_socket_receive_message()
    
    The API design here is a bit awkward — the in/out flags argument should
    actually have been an in flags argument and an out msg_flags argument.
    Clarify that a bit in the documentation.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=751924

 gio/gsocket.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)
---
diff --git a/gio/gsocket.c b/gio/gsocket.c
index 3abb077..7003842 100644
--- a/gio/gsocket.c
+++ b/gio/gsocket.c
@@ -4399,6 +4399,8 @@ cache_recv_address (GSocket *socket, struct sockaddr *native, int native_len)
  * values there are the same as the system values, and the flags
  * are passed in as-is, so you can pass in system-specific flags too
  * (and g_socket_receive_message() may pass system-specific flags out).
+ * Flags passed in to the parameter affect the receive operation; flags returned
+ * out of it are relevant to the specific returned message.
  *
  * As with g_socket_receive(), data may be discarded if @socket is
  * %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]