glib: Improve documentation for g_strfreev()
[platform/upstream/glib.git] / gio / gtcpwrapperconnection.h
1 /* GIO - GLib Input, Output and Streaming Library
2  * Copyright © 2010 Collabora Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published
6  * by the Free Software Foundation; either version 2 of the licence or (at
7  * your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General
15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
16  *
17  * Authors: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
18  *
19  */
20
21 #ifndef __G_TCP_WRAPPER_CONNECTION_H__
22 #define __G_TCP_WRAPPER_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/gtcpconnection.h>
29
30 G_BEGIN_DECLS
31
32 #define G_TYPE_TCP_WRAPPER_CONNECTION            (g_tcp_wrapper_connection_get_type ())
33 #define G_TCP_WRAPPER_CONNECTION(inst)           (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
34                                                   G_TYPE_TCP_WRAPPER_CONNECTION, GTcpWrapperConnection))
35 #define G_TCP_WRAPPER_CONNECTION_CLASS(class)    (G_TYPE_CHECK_CLASS_CAST ((class),                       \
36                                                   G_TYPE_TCP_WRAPPER_CONNECTION, GTcpWrapperConnectionClass))
37 #define G_IS_TCP_WRAPPER_CONNECTION(inst)        (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
38                                                   G_TYPE_TCP_WRAPPER_CONNECTION))
39 #define G_IS_TCP_WRAPPER_CONNECTION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
40                                                   G_TYPE_TCP_WRAPPER_CONNECTION))
41 #define G_TCP_WRAPPER_CONNECTION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
42                                                   G_TYPE_TCP_WRAPPER_CONNECTION, GTcpWrapperConnectionClass))
43
44 typedef struct _GTcpWrapperConnectionPrivate GTcpWrapperConnectionPrivate;
45 typedef struct _GTcpWrapperConnectionClass   GTcpWrapperConnectionClass;
46
47 struct _GTcpWrapperConnectionClass
48 {
49   GTcpConnectionClass parent_class;
50 };
51
52 struct _GTcpWrapperConnection
53 {
54   GTcpConnection parent_instance;
55   GTcpWrapperConnectionPrivate *priv;
56 };
57
58 GLIB_AVAILABLE_IN_ALL
59 GType              g_tcp_wrapper_connection_get_type (void) G_GNUC_CONST;
60
61 GLIB_AVAILABLE_IN_ALL
62 GSocketConnection *g_tcp_wrapper_connection_new                (GIOStream             *base_io_stream,
63                                                                 GSocket               *socket);
64 GLIB_AVAILABLE_IN_ALL
65 GIOStream         *g_tcp_wrapper_connection_get_base_io_stream (GTcpWrapperConnection *conn);
66
67 G_END_DECLS
68
69 #endif /* __G_TCP_WRAPPER_CONNECTION_H__ */