docs: fix typos
[platform/upstream/glib.git] / gio / gunixsocketaddress.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_UNIX_SOCKET_ADDRESS_H__
23 #define __G_UNIX_SOCKET_ADDRESS_H__
24
25 #include <gio/gio.h>
26
27 G_BEGIN_DECLS
28
29 #define G_TYPE_UNIX_SOCKET_ADDRESS         (g_unix_socket_address_get_type ())
30 #define G_UNIX_SOCKET_ADDRESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_UNIX_SOCKET_ADDRESS, GUnixSocketAddress))
31 #define G_UNIX_SOCKET_ADDRESS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_UNIX_SOCKET_ADDRESS, GUnixSocketAddressClass))
32 #define G_IS_UNIX_SOCKET_ADDRESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_UNIX_SOCKET_ADDRESS))
33 #define G_IS_UNIX_SOCKET_ADDRESS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_UNIX_SOCKET_ADDRESS))
34 #define G_UNIX_SOCKET_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_UNIX_SOCKET_ADDRESS, GUnixSocketAddressClass))
35
36 typedef struct _GUnixSocketAddress        GUnixSocketAddress;
37 typedef struct _GUnixSocketAddressClass   GUnixSocketAddressClass;
38 typedef struct _GUnixSocketAddressPrivate GUnixSocketAddressPrivate;
39
40 struct _GUnixSocketAddress
41 {
42   GSocketAddress parent_instance;
43
44   /*< private >*/
45   GUnixSocketAddressPrivate *priv;
46 };
47
48 struct _GUnixSocketAddressClass
49 {
50   GSocketAddressClass parent_class;
51 };
52
53 GLIB_AVAILABLE_IN_ALL
54 GType           g_unix_socket_address_get_type    (void) G_GNUC_CONST;
55
56 GLIB_AVAILABLE_IN_ALL
57 GSocketAddress *g_unix_socket_address_new             (const gchar        *path);
58 GLIB_DEPRECATED_FOR(g_unix_socket_address_new_with_type)
59 GSocketAddress *g_unix_socket_address_new_abstract    (const gchar        *path,
60                                                        gint                path_len);
61 GLIB_AVAILABLE_IN_ALL
62 GSocketAddress *g_unix_socket_address_new_with_type   (const gchar            *path,
63                                                        gint                    path_len,
64                                                        GUnixSocketAddressType  type);
65 GLIB_AVAILABLE_IN_ALL
66 const char *    g_unix_socket_address_get_path        (GUnixSocketAddress *address);
67 GLIB_AVAILABLE_IN_ALL
68 gsize           g_unix_socket_address_get_path_len    (GUnixSocketAddress *address);
69 GLIB_AVAILABLE_IN_ALL
70 GUnixSocketAddressType g_unix_socket_address_get_address_type (GUnixSocketAddress *address);
71 GLIB_DEPRECATED
72 gboolean        g_unix_socket_address_get_is_abstract (GUnixSocketAddress *address);
73
74 GLIB_AVAILABLE_IN_ALL
75 gboolean        g_unix_socket_address_abstract_names_supported (void);
76
77 G_END_DECLS
78
79 #endif /* __G_UNIX_SOCKET_ADDRESS_H__ */