Address parsing
[D-Bus low-level public API]

Parsing addresses of D-Bus servers. More...

Typedefs
typedef DBusAddressEntry	DBusAddressEntry
	Opaque type representing one of the semicolon-separated items in an address.
Functions
void	dbus_address_entries_free (DBusAddressEntry **entries)
	Frees a NULL-terminated array of address entries.
const char *	dbus_address_entry_get_method (DBusAddressEntry *entry)
	Returns the method string of an address entry.
const char *	dbus_address_entry_get_value (DBusAddressEntry *entry, const char *key)
	Returns a value from a key of an entry.
dbus_bool_t	dbus_parse_address (const char *address, DBusAddressEntry ***entry, int *array_len, DBusError *error)
	Parses an address string of the form:.
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.
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.

---

Detailed Description

Parsing addresses of D-Bus servers.

---

Function Documentation

void dbus_address_entries_free

(

DBusAddressEntry **

entries

)

Frees a NULL-terminated array of address entries.

Parameters:

entries

the array.

Definition at line 188 of file dbus-address.c.

References dbus_free(), and NULL.

Referenced by dbus_server_listen().

const char * dbus_address_entry_get_method

(

DBusAddressEntry *

entry

)

Returns the method string of an address entry.

For example, given the address entry "tcp:host=example.com" it would return the string "tcp"

Parameters:

entry

the entry.

Returns:

a string describing the method. This string must not be freed.

Definition at line 226 of file dbus-address.c.

References DBusAddressEntry::method.

Referenced by _dbus_server_listen_platform_specific(), _dbus_server_listen_socket(), _dbus_transport_open_platform_specific(), _dbus_transport_open_socket(), and dbus_server_listen().

const char * dbus_address_entry_get_value	(	DBusAddressEntry *	entry,
		const char *	key
	)

Returns a value from a key of an entry.

For example, given the address "tcp:host=example.com,port=8073" if you asked for the key "host" you would get the value "example.com"

The returned value is already unescaped.

Parameters:

	entry	the entry.
	key	the key.

Returns:

the key value. This string must not be freed.

Definition at line 243 of file dbus-address.c.

References _dbus_assert, _dbus_list_get_first_link(), _dbus_list_get_next_link, _dbus_string_equal_c_str(), DBusList::data, DBusAddressEntry::keys, NULL, and DBusAddressEntry::values.

Referenced by _dbus_server_listen_platform_specific(), _dbus_server_listen_socket(), _dbus_transport_open(), _dbus_transport_open_platform_specific(), and _dbus_transport_open_socket().

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.

Parameters:

value

the unescaped value

Returns:

newly-allocated escaped value or NULL if no memory

Definition at line 575 of file dbus-address.c.

References _dbus_address_append_escaped(), _dbus_string_free(), _dbus_string_init(), _dbus_string_init_const(), _dbus_string_steal_data(), and NULL.

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.

Note that dbus_address_entry_get_value() returns an already-unescaped value.

Parameters:

	value	the escaped value
	error	error to set if the unescaping fails

Returns:

newly-allocated unescaped value or NULL if no memory

Definition at line 609 of file dbus-address.c.

References _dbus_assert, _dbus_string_free(), _dbus_string_init(), _dbus_string_init_const(), _dbus_string_steal_data(), dbus_error_is_set(), and NULL.

dbus_bool_t dbus_parse_address	(	const char *	address,
		DBusAddressEntry ***	entry,
		int *	array_len,
		DBusError *	error
	)

Parses an address string of the form:.

method:key=value,key=value;method:key=value

See the D-Bus specification for complete docs on the format.

When connecting to an address, the first address entries in the semicolon-separated list should be tried first.

Parameters:

	address	the address.
	entry	return location to an array of entries.
	array_len	return location for array length.
	error	address where an error can be returned.

Returns:

TRUE on success, FALSE otherwise.

Definition at line 362 of file dbus-address.c.

References _dbus_assert, _dbus_list_append(), _dbus_list_clear(), _dbus_list_get_first_link(), _dbus_list_get_length(), _dbus_list_get_next_link, _dbus_string_copy_len(), _dbus_string_find(), _dbus_string_find_to(), _dbus_string_free(), _dbus_string_init(), _dbus_string_init_const(), DBusList::data, DBUS_ERROR_BAD_ADDRESS, dbus_error_is_set(), DBUS_ERROR_NO_MEMORY, dbus_free(), dbus_new, dbus_new0, dbus_set_error(), FALSE, DBusAddressEntry::keys, DBusAddressEntry::method, NULL, TRUE, and DBusAddressEntry::values.

Referenced by dbus_server_listen().

---