Merge remote-tracking branch 'gvdb/master'
[platform/upstream/glib.git] / gio / gsocketconnectable.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2008 Red Hat, Inc.
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 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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
22 #error "Only <gio/gio.h> can be included directly."
23 #endif
24
25 #ifndef __G_SOCKET_CONNECTABLE_H__
26 #define __G_SOCKET_CONNECTABLE_H__
27
28 #include <gio/giotypes.h>
29
30 G_BEGIN_DECLS
31
32 #define G_TYPE_SOCKET_CONNECTABLE            (g_socket_connectable_get_type ())
33 #define G_SOCKET_CONNECTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectable))
34 #define G_IS_SOCKET_CONNECTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SOCKET_CONNECTABLE))
35 #define G_SOCKET_CONNECTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectableIface))
36
37 /**
38  * GSocketConnectable:
39  *
40  * Interface for objects that contain or generate #GSocketAddress<!-- -->es.
41  */
42 typedef struct _GSocketConnectableIface GSocketConnectableIface;
43
44 /**
45  * GSocketConnectableIface:
46  * @g_iface: The parent interface.
47  * @enumerate: Creates a #GSocketAddressEnumerator
48  * @proxy_enumerate: Creates a #GProxyAddressEnumerator
49  *
50  * Provides an interface for returning a #GSocketAddressEnumerator
51  * and #GProxyAddressEnumerator
52  */
53 struct _GSocketConnectableIface
54 {
55   GTypeInterface g_iface;
56
57   /* Virtual Table */
58
59   GSocketAddressEnumerator * (* enumerate)       (GSocketConnectable *connectable);
60
61   GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
62
63 };
64
65 GType                     g_socket_connectable_get_type  (void) G_GNUC_CONST;
66
67 GSocketAddressEnumerator *g_socket_connectable_enumerate (GSocketConnectable *connectable);
68
69 GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
70
71 G_END_DECLS
72
73
74 #endif /* __G_SOCKET_CONNECTABLE_H__ */