1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright © 2009 Codethink Limited
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 *
18 * Authors: Ryan Lortie <desrt@desrt.ca>
19 */
20
21#ifndef __G_SOCKET_CONTROL_MESSAGE_H__
22#define __G_SOCKET_CONTROL_MESSAGE_H__
23
24#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25#error "Only <gio/gio.h> can be included directly."
26#endif
27
28#include <gio/giotypes.h>
29
30G_BEGIN_DECLS
31
32#define G_TYPE_SOCKET_CONTROL_MESSAGE (g_socket_control_message_get_type ())
33#define G_SOCKET_CONTROL_MESSAGE(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
34 G_TYPE_SOCKET_CONTROL_MESSAGE, \
35 GSocketControlMessage))
36#define G_SOCKET_CONTROL_MESSAGE_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
37 G_TYPE_SOCKET_CONTROL_MESSAGE, \
38 GSocketControlMessageClass))
39#define G_IS_SOCKET_CONTROL_MESSAGE(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
40 G_TYPE_SOCKET_CONTROL_MESSAGE))
41#define G_IS_SOCKET_CONTROL_MESSAGE_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
42 G_TYPE_SOCKET_CONTROL_MESSAGE))
43#define G_SOCKET_CONTROL_MESSAGE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
44 G_TYPE_SOCKET_CONTROL_MESSAGE, \
45 GSocketControlMessageClass))
46
47typedef struct _GSocketControlMessagePrivate GSocketControlMessagePrivate;
48typedef struct _GSocketControlMessageClass GSocketControlMessageClass;
49
50/**
51 * GSocketControlMessageClass:
52 * @get_size: gets the size of the message.
53 * @get_level: gets the protocol of the message.
54 * @get_type: gets the protocol specific type of the message.
55 * @serialize: Writes out the message data.
56 * @deserialize: Tries to deserialize a message.
57 *
58 * Class structure for #GSocketControlMessage.
59 **/
60
61struct _GSocketControlMessageClass
62{
63 GObjectClass parent_class;
64
65 gsize (* get_size) (GSocketControlMessage *message);
66 int (* get_level) (GSocketControlMessage *message);
67 int (* get_type) (GSocketControlMessage *message);
68 void (* serialize) (GSocketControlMessage *message,
69 gpointer data);
70 GSocketControlMessage *(* deserialize) (int level,
71 int type,
72 gsize size,
73 gpointer data);
74
75 /*< private >*/
76
77 /* Padding for future expansion */
78 void (*_g_reserved1) (void);
79 void (*_g_reserved2) (void);
80 void (*_g_reserved3) (void);
81 void (*_g_reserved4) (void);
82 void (*_g_reserved5) (void);
83};
84
85struct _GSocketControlMessage
86{
87 GObject parent_instance;
88 GSocketControlMessagePrivate *priv;
89};
90
91GLIB_AVAILABLE_IN_ALL
92GType g_socket_control_message_get_type (void) G_GNUC_CONST;
93GLIB_AVAILABLE_IN_ALL
94gsize g_socket_control_message_get_size (GSocketControlMessage *message);
95GLIB_AVAILABLE_IN_ALL
96int g_socket_control_message_get_level (GSocketControlMessage *message);
97GLIB_AVAILABLE_IN_ALL
98int g_socket_control_message_get_msg_type (GSocketControlMessage *message);
99GLIB_AVAILABLE_IN_ALL
100void g_socket_control_message_serialize (GSocketControlMessage *message,
101 gpointer data);
102GLIB_AVAILABLE_IN_ALL
103GSocketControlMessage *g_socket_control_message_deserialize (int level,
104 int type,
105 gsize size,
106 gpointer data);
107
108
109G_END_DECLS
110
111#endif /* __G_SOCKET_CONTROL_MESSAGE_H__ */
112