2006-10-21 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-address.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-address.h  Server address parser.
3  *
4  * Copyright (C) 2003  CodeFactory AB
5  *
6  * Licensed under the Academic Free License version 2.1
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_ADDRESS_H
28 #define DBUS_ADDRESS_H
29
30 #include <dbus/dbus-types.h>
31 #include <dbus/dbus-errors.h>
32
33 DBUS_BEGIN_DECLS
34
35 /**
36  * @addtogroup DBusAddress
37  * @{
38  */
39
40 /** Opaque type representing one of the semicolon-separated items in an address */
41 typedef struct DBusAddressEntry DBusAddressEntry;
42
43 dbus_bool_t dbus_parse_address            (const char         *address,
44                                            DBusAddressEntry ***entry,
45                                            int                *array_len,
46                                            DBusError          *error);
47 const char *dbus_address_entry_get_value  (DBusAddressEntry   *entry,
48                                            const char         *key);
49 const char *dbus_address_entry_get_method (DBusAddressEntry   *entry);
50 void        dbus_address_entries_free     (DBusAddressEntry  **entries);
51
52 char* dbus_address_escape_value   (const char *value);
53 char* dbus_address_unescape_value (const char *value,
54                                    DBusError  *error);
55
56 /** @} */
57
58 DBUS_END_DECLS
59
60 #endif /* DBUS_ADDRESS_H */
61