Fix the docs build
[platform/upstream/glib.git] / gio / gtcpconnection.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright © 2008, 2009 Codethink Limited
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published
7  * by the Free Software Foundation; either version 2 of the licence or (at
8  * 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_TCP_CONNECTION_H__
22 #define __G_TCP_CONNECTION_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/gsocketconnection.h>
29
30 G_BEGIN_DECLS
31
32 #define G_TYPE_TCP_CONNECTION                               (g_tcp_connection_get_type ())
33 #define G_TCP_CONNECTION(inst)                              (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
34                                                              G_TYPE_TCP_CONNECTION, GTcpConnection))
35 #define G_TCP_CONNECTION_CLASS(class)                       (G_TYPE_CHECK_CLASS_CAST ((class),                       \
36                                                              G_TYPE_TCP_CONNECTION, GTcpConnectionClass))
37 #define G_IS_TCP_CONNECTION(inst)                           (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
38                                                              G_TYPE_TCP_CONNECTION))
39 #define G_IS_TCP_CONNECTION_CLASS(class)                    (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
40                                                              G_TYPE_TCP_CONNECTION))
41 #define G_TCP_CONNECTION_GET_CLASS(inst)                    (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
42                                                              G_TYPE_TCP_CONNECTION, GTcpConnectionClass))
43
44 typedef struct _GTcpConnectionPrivate                       GTcpConnectionPrivate;
45 typedef struct _GTcpConnectionClass                         GTcpConnectionClass;
46
47 struct _GTcpConnectionClass
48 {
49   GSocketConnectionClass parent_class;
50 };
51
52 struct _GTcpConnection
53 {
54   GSocketConnection parent_instance;
55   GTcpConnectionPrivate *priv;
56 };
57
58 GLIB_AVAILABLE_IN_ALL
59 GType    g_tcp_connection_get_type                (void) G_GNUC_CONST;
60
61 GLIB_AVAILABLE_IN_ALL
62 void     g_tcp_connection_set_graceful_disconnect (GTcpConnection *connection,
63                                                    gboolean        graceful_disconnect);
64 GLIB_AVAILABLE_IN_ALL
65 gboolean g_tcp_connection_get_graceful_disconnect (GTcpConnection *connection);
66
67 G_END_DECLS
68
69 #endif /* __G_TCP_CONNECTION_H__ */