index.html
Main Page
|
modules.html
Modules
|
namespaces.html
Namespace List
|
hierarchy.html
Class Hierarchy
|
annotated.html
Data Structures
|
dirs.html
Directories
|
files.html
File List
|
namespacemembers.html
Namespace Members
|
functions.html
Data Fields
|
pages.html
Related Pages
Address parsing
[
group__DBus.html
D-BUS low-level public API
]
Parsing addresses of D-BUS servers.
#_details
More...
Defines
#define
group__DBusAddress.html#ga9
_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE
(b)
Functions
void
group__DBusAddress.html#ga0
dbus_address_entries_free
(
structDBusAddressEntry.html
DBusAddressEntry
**entries)
Frees a
group__DBusMacros.html#ga4
NULL
-terminated array of address entries.
#ga0
const char *
group__DBusAddress.html#ga2
dbus_address_entry_get_method
(
structDBusAddressEntry.html
DBusAddressEntry
*entry)
Returns the method string of an address entry.
#ga2
const char *
group__DBusAddress.html#ga3
dbus_address_entry_get_value
(
structDBusAddressEntry.html
DBusAddressEntry
*entry, const char *key)
Returns a value from a key of an entry.
#ga3
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusAddress.html#ga4
_dbus_address_append_escaped
(
structDBusString.html
DBusString
*escaped, const
structDBusString.html
DBusString
*unescaped)
Appends an escaped version of one string to another string, using the D-BUS address escaping mechanism.
#ga4
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusAddress.html#ga6
dbus_parse_address
(const char *address,
structDBusAddressEntry.html
DBusAddressEntry
***entry, int *array_len,
structDBusError.html
DBusError
*error)
Parses an address string of the form:.
#ga6
char *
group__DBusAddress.html#ga7
dbus_address_escape_value
(const char *value)
Escapes the given string as a value in a key=value pair for a D-BUS address.
#ga7
char *
group__DBusAddress.html#ga8
dbus_address_unescape_value
(const char *value,
structDBusError.html
DBusError
*error)
Unescapes the given string as a value in a key=value pair for a D-BUS address.
#ga8
Detailed Description
Parsing addresses of D-BUS servers.
Define Documentation
#define _DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE
(
b
)
Value:
(((b) >=
'a'
&& (b) <=
'z'
) ||                 \
((b) >=
'A'
&& (b) <=
'Z'
) ||                 \
((b) >=
'0'
&& (b) <=
'9'
) ||                 \
(b) ==
'-'
||                                 \
(b) ==
'_'
||                                 \
(b) ==
'/'
||                                 \
(b) ==
'\\'
||                                \
(b) ==
'.'
)
Definition at line
dbus-address_8c-source.html#l00168
168
of file
dbus-address_8c-source.html
dbus-address.c
.
Referenced by
dbus-address_8c-source.html#l00187
_dbus_address_append_escaped()
.
Function Documentation
group__DBusTypes.html#ga2
dbus_bool_t
_dbus_address_append_escaped
(
structDBusString.html
DBusString
*
escaped
,
const
structDBusString.html
DBusString
*
unescaped
)
Appends an escaped version of one string to another string, using the D-BUS address escaping mechanism.
Parameters:
escaped
the string to append to
unescaped
the string to escape
Returns:
group__DBusMacros.html#ga3
FALSE
if no memory
Definition at line
dbus-address_8c-source.html#l00187
187
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-address_8c-source.html#l00168
_DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE
,
dbus-string_8c-source.html#l01273
_dbus_string_append_byte()
,
dbus-string_8c-source.html#l02272
_dbus_string_append_byte_as_hex()
,
dbus-string_8c-source.html#l00853
_dbus_string_set_length()
,
group__DBusMacros.html#ga3
FALSE
, and
group__DBusMacros.html#ga2
TRUE
.
Referenced by
dbus-server-unix_8c-source.html#l00315
_dbus_server_new_for_domain_socket()
,
dbus-server-unix_8c-source.html#l00395
_dbus_server_new_for_tcp_socket()
, and
dbus-address_8c-source.html#l00533
dbus_address_escape_value()
.
void dbus_address_entries_free
(
structDBusAddressEntry.html
DBusAddressEntry
**
entries
)
Frees a
group__DBusMacros.html#ga4
NULL
-terminated array of address entries.
Parameters:
entries
the array.
Definition at line
dbus-address_8c-source.html#l00097
97
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-memory_8c-source.html#l00612
dbus_free()
, and
group__DBusMacros.html#ga4
NULL
.
Referenced by
dbus-server_8c-source.html#l00486
dbus_server_listen()
.
const char* dbus_address_entry_get_method
(
structDBusAddressEntry.html
DBusAddressEntry
*
entry
)
Returns the method string of an address entry.
Parameters:
entry
the entry.
Returns:
a string describing the method. This string must not be freed.
Definition at line
dbus-address_8c-source.html#l00133
133
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-address_8c-source.html#l00045
DBusAddressEntry::method
.
Referenced by
dbus-transport_8c-source.html#l00212
_dbus_transport_open()
, and
dbus-server_8c-source.html#l00486
dbus_server_listen()
.
const char* dbus_address_entry_get_value
(
structDBusAddressEntry.html
DBusAddressEntry
*
entry
,
const char *
key
)
Returns a value from a key of an entry.
Parameters:
entry
the entry.
key
the key.
Returns:
the key value. This string must not be freed.
Definition at line
dbus-address_8c-source.html#l00146
146
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-internals_8h-source.html#l00100
_dbus_assert
,
dbus-list_8c-source.html#l00581
_dbus_list_get_first_link()
,
dbus-list_8h-source.html#l00094
_dbus_list_get_next_link
,
dbus-string_8c-source.html#l02197
_dbus_string_equal_c_str()
,
dbus-list_8h-source.html#l00039
DBusList::data
,
dbus-address_8c-source.html#l00047
DBusAddressEntry::keys
,
group__DBusMacros.html#ga4
NULL
, and
dbus-address_8c-source.html#l00048
DBusAddressEntry::values
.
Referenced by
dbus-transport_8c-source.html#l00212
_dbus_transport_open()
, and
dbus-server_8c-source.html#l00486
dbus_server_listen()
.
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
group__DBusMacros.html#ga4
NULL
if no memory
Definition at line
dbus-address_8c-source.html#l00533
533
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-address_8c-source.html#l00187
_dbus_address_append_escaped()
,
dbus-string_8c-source.html#l00261
_dbus_string_free()
,
dbus-string_8c-source.html#l00174
_dbus_string_init()
,
dbus-string_8c-source.html#l00208
_dbus_string_init_const()
,
dbus-string_8c-source.html#l00607
_dbus_string_steal_data()
, and
group__DBusMacros.html#ga4
NULL
.
char* dbus_address_unescape_value
(
const char *
value
,
structDBusError.html
DBusError
*
error
)
Unescapes the given string as a value in a key=value pair for a D-BUS address.
Parameters:
value
the escaped value
error
error to set if the unescaping fails
Returns:
newly-allocated unescaped value or
group__DBusMacros.html#ga4
NULL
if no memory
Definition at line
dbus-address_8c-source.html#l00566
566
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-internals_8h-source.html#l00100
_dbus_assert
,
dbus-string_8c-source.html#l00261
_dbus_string_free()
,
dbus-string_8c-source.html#l00174
_dbus_string_init()
,
dbus-string_8c-source.html#l00208
_dbus_string_init_const()
,
dbus-string_8c-source.html#l00607
_dbus_string_steal_data()
,
dbus-errors_8c-source.html#l00287
dbus_error_is_set()
, and
group__DBusMacros.html#ga4
NULL
.
group__DBusTypes.html#ga2
dbus_bool_t
dbus_parse_address
(
const char *
address
,
structDBusAddressEntry.html
DBusAddressEntry
***
entry
,
int *
array_len
,
structDBusError.html
DBusError
*
error
)
Parses an address string of the form:.
method:key=value,key=value;method:key=value
todo.html#_todo000001
Todo:
document address format in the specification
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:
group__DBusMacros.html#ga2
TRUE
on success,
group__DBusMacros.html#ga3
FALSE
otherwise.
Definition at line
dbus-address_8c-source.html#l00320
320
of file
dbus-address_8c-source.html
dbus-address.c
.
References
dbus-internals_8h-source.html#l00100
_dbus_assert
,
dbus-list_8c-source.html#l00249
_dbus_list_append()
,
dbus-list_8c-source.html#l00556
_dbus_list_clear()
,
dbus-list_8c-source.html#l00581
_dbus_list_get_first_link()
,
dbus-list_8c-source.html#l00767
_dbus_list_get_length()
,
dbus-list_8h-source.html#l00094
_dbus_list_get_next_link
,
dbus-string_8c-source.html#l01567
_dbus_string_copy_len()
,
dbus-string_8c-source.html#l01783
_dbus_string_find()
,
dbus-string_8c-source.html#l01810
_dbus_string_find_to()
,
dbus-string_8c-source.html#l00261
_dbus_string_free()
,
dbus-string_8c-source.html#l00174
_dbus_string_init()
,
dbus-string_8c-source.html#l00208
_dbus_string_init_const()
,
dbus-list_8h-source.html#l00039
DBusList::data
,
dbus-errors_8c-source.html#l00287
dbus_error_is_set()
,
dbus-memory_8c-source.html#l00612
dbus_free()
,
dbus-memory_8h-source.html#l00041
dbus_new
,
dbus-memory_8h-source.html#l00042
dbus_new0
,
dbus-errors_8c-source.html#l00313
dbus_set_error()
,
group__DBusMacros.html#ga3
FALSE
,
dbus-address_8c-source.html#l00047
DBusAddressEntry::keys
,
dbus-address_8c-source.html#l00045
DBusAddressEntry::method
,
group__DBusMacros.html#ga4
NULL
,
group__DBusMacros.html#ga2
TRUE
, and
dbus-address_8c-source.html#l00048
DBusAddressEntry::values
.
Referenced by
dbus-server_8c-source.html#l00486
dbus_server_listen()
.
Generated on Tue Sep 13 01:28:08 2005 for D-BUS by
http://www.doxygen.org/index.html
doxygen
1.4.4
