GSocketControlMessage: clean up confusing code
[platform/upstream/glib.git] / gio / gsocketcontrolmessage.c
index 27420d7..a1879bb 100644 (file)
 /**
  * SECTION: gsocketcontrolmessage
  * @title: GSocketControlMessage
- * @short_description: a #GSocket control message
+ * @short_description: GSocket control message
  * @see_also: #GSocket.
  *
  * A #GSocketControlMessage is a special-purpose utility message that
- * can be sent to or received from a #GSocket.  These types of
+ * can be sent to or received from a #GSocket. These types of
  * messages are often called "ancillary data".
  *
  * The message can represent some sort of special instruction to or
  * g_socket_receive_message() to read such a message.
  *
  * Since: 2.22
- **/
+ */
 
 #include "config.h"
 #include "gsocketcontrolmessage.h"
+#include "gnetworkingprivate.h"
 #include "glibintl.h"
 
 #ifndef G_OS_WIN32
+#include "gunixcredentialsmessage.h"
 #include "gunixfdmessage.h"
-#include <sys/socket.h>
-#else
-# include <winsock2.h>
-# include <mswsock.h>
 #endif
 
-#include "gioalias.h"
 
 G_DEFINE_ABSTRACT_TYPE (GSocketControlMessage,
                         g_socket_control_message,
@@ -70,7 +67,7 @@ G_DEFINE_ABSTRACT_TYPE (GSocketControlMessage,
  * Returns: The number of bytes required.
  *
  * Since: 2.22
- **/
+ */
 gsize
 g_socket_control_message_get_size (GSocketControlMessage *message)
 {
@@ -86,10 +83,10 @@ g_socket_control_message_get_size (GSocketControlMessage *message)
  * Returns the "level" (i.e. the originating protocol) of the control message.
  * This is often SOL_SOCKET.
  *
- * Returns: and int describing the level
+ * Returns: an integer describing the level
  *
  * Since: 2.22
- **/
+ */
 int
 g_socket_control_message_get_level (GSocketControlMessage *message)
 {
@@ -102,13 +99,13 @@ g_socket_control_message_get_level (GSocketControlMessage *message)
  * g_socket_control_message_get_msg_type:
  * @message: a #GSocketControlMessage
  *
- * Returns the protocol specify type  of the control message.
- * For instance, for unix fd passing this would be SCM_RIGHTS.
+ * Returns the protocol specific type of the control message.
+ * For instance, for UNIX fd passing this would be SCM_RIGHTS.
  *
- * Returns: and int describing the level
+ * Returns: an integer describing the type of control message
  *
  * Since: 2.22
- **/
+ */
 int
 g_socket_control_message_get_msg_type (GSocketControlMessage *message)
 {
@@ -130,14 +127,14 @@ g_socket_control_message_get_msg_type (GSocketControlMessage *message)
  * object.
  *
  * Since: 2.22
- **/
+ */
 void
 g_socket_control_message_serialize (GSocketControlMessage *message,
                                    gpointer               data)
 {
   g_return_if_fail (G_IS_SOCKET_CONTROL_MESSAGE (message));
 
-  return G_SOCKET_CONTROL_MESSAGE_GET_CLASS (message)->serialize (message, data);
+  G_SOCKET_CONTROL_MESSAGE_GET_CLASS (message)->serialize (message, data);
 }
 
 
@@ -151,13 +148,31 @@ g_socket_control_message_class_init (GSocketControlMessageClass *class)
 {
 }
 
+/**
+ * g_socket_control_message_deserialize:
+ * @level: a socket level
+ * @type: a socket control message type for the given @level
+ * @size: the size of the data in bytes
+ * @data: pointer to the message data
+ *
+ * Tries to deserialize a socket control message of a given
+ * @level and @type. This will ask all known (to GType) subclasses
+ * of #GSocketControlMessage if they can understand this kind
+ * of message and if so deserialize it into a #GSocketControlMessage.
+ *
+ * If there is no implementation for this kind of control message, %NULL
+ * will be returned.
+ *
+ * Returns: the deserialized message or %NULL
+ *
+ * Since: 2.22
+ */
 GSocketControlMessage *
-g_socket_control_message_deserialize  (int                    level,
-                                      int                    type,
-                                      gsize                  size,
-                                      gpointer               data)
+g_socket_control_message_deserialize (int      level,
+                                     int      type,
+                                     gsize    size,
+                                     gpointer data)
 {
-  GSocketControlMessageClass *klass;
   GSocketControlMessage *message;
   GType *message_types;
   guint n_message_types;
@@ -168,6 +183,7 @@ g_socket_control_message_deserialize  (int                    level,
 
   /* Ensure we know about the built in types */
 #ifndef G_OS_WIN32
+  a_type = g_unix_credentials_message_get_type ();
   a_type = g_unix_fd_message_get_type ();
 #endif
 
@@ -176,16 +192,14 @@ g_socket_control_message_deserialize  (int                    level,
   message = NULL;
   for (i = 0; i < n_message_types; i++)
     {
-      klass = (GSocketControlMessageClass *)g_type_class_ref (type);
+      GSocketControlMessageClass *class;
 
-      if (klass && klass->deserialize)
-       {
-         message = klass->deserialize (level, type, size, data);
-         g_type_class_unref ((GTypeClass *) klass);
-       }
+      class = g_type_class_ref (message_types[i]);
+      message = class->deserialize (level, type, size, data);
+      g_type_class_unref (class);
 
       if (message != NULL)
-       break;
+        break;
     }
 
   g_free (message_types);
@@ -195,6 +209,3 @@ g_socket_control_message_deserialize  (int                    level,
 
   return message;
 }
-
-#define __G_SOCKET_CONTROL_MESSAGE_C__
-#include "gioaliasdef.c"