docs: fix typos
[platform/upstream/glib.git] / gio / ginetsocketaddress.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
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, see <http://www.gnu.org/licenses/>.
17  *
18  * Authors: Christian Kellner <gicmo@gnome.org>
19  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
20  */
21
22 #ifndef __G_INET_SOCKET_ADDRESS_H__
23 #define __G_INET_SOCKET_ADDRESS_H__
24
25 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26 #error "Only <gio/gio.h> can be included directly."
27 #endif
28
29 #include <gio/gsocketaddress.h>
30
31 G_BEGIN_DECLS
32
33 #define G_TYPE_INET_SOCKET_ADDRESS         (g_inet_socket_address_get_type ())
34 #define G_INET_SOCKET_ADDRESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_INET_SOCKET_ADDRESS, GInetSocketAddress))
35 #define G_INET_SOCKET_ADDRESS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_INET_SOCKET_ADDRESS, GInetSocketAddressClass))
36 #define G_IS_INET_SOCKET_ADDRESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_INET_SOCKET_ADDRESS))
37 #define G_IS_INET_SOCKET_ADDRESS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_INET_SOCKET_ADDRESS))
38 #define G_INET_SOCKET_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_INET_SOCKET_ADDRESS, GInetSocketAddressClass))
39
40 typedef struct _GInetSocketAddressClass   GInetSocketAddressClass;
41 typedef struct _GInetSocketAddressPrivate GInetSocketAddressPrivate;
42
43 struct _GInetSocketAddress
44 {
45   GSocketAddress parent_instance;
46
47   /*< private >*/
48   GInetSocketAddressPrivate *priv;
49 };
50
51 struct _GInetSocketAddressClass
52 {
53   GSocketAddressClass parent_class;
54 };
55
56 GLIB_AVAILABLE_IN_ALL
57 GType           g_inet_socket_address_get_type        (void) G_GNUC_CONST;
58
59 GLIB_AVAILABLE_IN_ALL
60 GSocketAddress *g_inet_socket_address_new             (GInetAddress       *address,
61                                                        guint16             port);
62 GLIB_AVAILABLE_IN_2_40
63 GSocketAddress *g_inet_socket_address_new_from_string (const char         *address,
64                                                        guint               port);
65
66 GLIB_AVAILABLE_IN_ALL
67 GInetAddress *  g_inet_socket_address_get_address     (GInetSocketAddress *address);
68 GLIB_AVAILABLE_IN_ALL
69 guint16         g_inet_socket_address_get_port        (GInetSocketAddress *address);
70
71 GLIB_AVAILABLE_IN_2_32
72 guint32         g_inet_socket_address_get_flowinfo    (GInetSocketAddress *address);
73 GLIB_AVAILABLE_IN_2_32
74 guint32         g_inet_socket_address_get_scope_id    (GInetSocketAddress *address);
75
76 G_END_DECLS
77
78 #endif /* __G_INET_SOCKET_ADDRESS_H__ */