docs: fix typos
[platform/upstream/glib.git] / gio / gnetworkaddress.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, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef __G_NETWORK_ADDRESS_H__
20 #define __G_NETWORK_ADDRESS_H__
21
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
24 #endif
25
26 #include <gio/giotypes.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_NETWORK_ADDRESS         (g_network_address_get_type ())
31 #define G_NETWORK_ADDRESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_NETWORK_ADDRESS, GNetworkAddress))
32 #define G_NETWORK_ADDRESS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_NETWORK_ADDRESS, GNetworkAddressClass))
33 #define G_IS_NETWORK_ADDRESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_NETWORK_ADDRESS))
34 #define G_IS_NETWORK_ADDRESS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_NETWORK_ADDRESS))
35 #define G_NETWORK_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_NETWORK_ADDRESS, GNetworkAddressClass))
36
37 typedef struct _GNetworkAddressClass   GNetworkAddressClass;
38 typedef struct _GNetworkAddressPrivate GNetworkAddressPrivate;
39
40 struct _GNetworkAddress
41 {
42   GObject parent_instance;
43
44   /*< private >*/
45   GNetworkAddressPrivate *priv;
46 };
47
48 struct _GNetworkAddressClass
49 {
50   GObjectClass parent_class;
51
52 };
53
54 GLIB_AVAILABLE_IN_ALL
55 GType               g_network_address_get_type     (void) G_GNUC_CONST;
56
57 GLIB_AVAILABLE_IN_ALL
58 GSocketConnectable *g_network_address_new          (const gchar      *hostname,
59                                                     guint16           port);
60 GLIB_AVAILABLE_IN_ALL
61 GSocketConnectable *g_network_address_parse        (const gchar      *host_and_port,
62                                                     guint16           default_port,
63                                                     GError          **error);
64 GLIB_AVAILABLE_IN_ALL
65 GSocketConnectable *g_network_address_parse_uri    (const gchar      *uri,
66                                                     guint16           default_port,
67                                                     GError          **error);
68 GLIB_AVAILABLE_IN_ALL
69 const gchar        *g_network_address_get_hostname (GNetworkAddress  *addr);
70 GLIB_AVAILABLE_IN_ALL
71 guint16             g_network_address_get_port     (GNetworkAddress  *addr);
72 GLIB_AVAILABLE_IN_ALL
73 const gchar        *g_network_address_get_scheme   (GNetworkAddress  *addr);
74
75
76 G_END_DECLS
77
78 #endif /* __G_NETWORK_ADDRESS_H__ */