D-Bus 1.14.8

dbus-address.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
41 typedef struct DBusAddressEntry DBusAddressEntry;
42
43DBUS_EXPORT
44 dbus_bool_t dbus_parse_address (const char *address,
45 DBusAddressEntry ***entry_result,
46 int *array_len,
47 DBusError *error);
48DBUS_EXPORT
49 const char *dbus_address_entry_get_value (DBusAddressEntry *entry,
50 const char *key);
51DBUS_EXPORT
52 const char *dbus_address_entry_get_method (DBusAddressEntry *entry);
53DBUS_EXPORT
54 void dbus_address_entries_free (DBusAddressEntry **entries);
55
56DBUS_EXPORT
57 char* dbus_address_escape_value (const char *value);
58DBUS_EXPORT
59 char* dbus_address_unescape_value (const char *value,
60 DBusError *error);
61
74 static inline void
75dbus_clear_address_entries (DBusAddressEntry ***pointer_to_entries)
76{
77 _dbus_clear_pointer_impl (DBusAddressEntry *, pointer_to_entries,
78 dbus_address_entries_free);
79}
80
83 DBUS_END_DECLS
84
85#endif /* DBUS_ADDRESS_H */
dbus_address_entries_free
void dbus_address_entries_free(DBusAddressEntry **entries)
Frees a NULL-terminated array of address entries.
Definition: dbus-address.c:192
dbus_parse_address
dbus_bool_t dbus_parse_address(const char *address, DBusAddressEntry ***entry_result, int *array_len, DBusError *error)
Parses an address string of the form:
Definition: dbus-address.c:366
dbus_address_entry_get_method
const char * dbus_address_entry_get_method(DBusAddressEntry *entry)
Returns the method string of an address entry.
Definition: dbus-address.c:230
dbus_address_unescape_value
char * dbus_address_unescape_value(const char *value, DBusError *error)
Unescapes the given string as a value in a key=value pair for a D-Bus address.
Definition: dbus-address.c:620
dbus_address_escape_value
char * dbus_address_escape_value(const char *value)
Escapes the given string as a value in a key=value pair for a D-Bus address.
Definition: dbus-address.c:586
dbus_address_entry_get_value
const char * dbus_address_entry_get_value(DBusAddressEntry *entry, const char *key)
Returns a value from a key of an entry.
Definition: dbus-address.c:247
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:47
DBusError
Object representing an exception.
Definition: dbus-errors.h:49