mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-25 23:16:14 +01:00
Docs: Change DBus to D-Bus
This commit is contained in:
parent
27a067a3c8
commit
3ac7e0a7fe
@ -1179,7 +1179,7 @@ typedef enum
|
||||
* GDBusSignalFlags:
|
||||
* @G_DBUS_SIGNAL_FLAGS_NONE: No flags set.
|
||||
* @G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE: Don't actually send the AddMatch
|
||||
* DBus call for this signal subscription. This gives you more control
|
||||
* D-Bus call for this signal subscription. This gives you more control
|
||||
* over which match rules you add (but you must add them manually).
|
||||
*
|
||||
* Flags used when subscribing to signals via g_dbus_connection_signal_subscribe().
|
||||
|
@ -83,7 +83,7 @@
|
||||
* values is permitted (eg: 0 to 255 is a valid byte). Special checks
|
||||
* need to be performed for booleans (only 0 or 1 allowed), strings
|
||||
* (properly nul-terminated) and object paths and signature strings
|
||||
* (meeting the DBus specification requirements).
|
||||
* (meeting the D-Bus specification requirements).
|
||||
*/
|
||||
|
||||
/* < private >
|
||||
@ -1600,12 +1600,12 @@ g_variant_serialiser_is_string (gconstpointer data,
|
||||
|
||||
/* < private >
|
||||
* g_variant_serialiser_is_object_path:
|
||||
* @data: a possible DBus object path
|
||||
* @data: a possible D-Bus object path
|
||||
* @size: the size of @data
|
||||
*
|
||||
* Performs the checks for being a valid string.
|
||||
*
|
||||
* Also, ensures that @data is a valid DBus object path, as per the DBus
|
||||
* Also, ensures that @data is a valid DBus object path, as per the D-Bus
|
||||
* specification.
|
||||
*/
|
||||
gboolean
|
||||
@ -1652,13 +1652,13 @@ g_variant_serialiser_is_object_path (gconstpointer data,
|
||||
|
||||
/* < private >
|
||||
* g_variant_serialiser_is_signature:
|
||||
* @data: a possible DBus signature
|
||||
* @data: a possible D-Bus signature
|
||||
* @size: the size of @data
|
||||
*
|
||||
* Performs the checks for being a valid string.
|
||||
*
|
||||
* Also, ensures that @data is a valid DBus type signature, as per the
|
||||
* DBus specification.
|
||||
* Also, ensures that @data is a valid D-Bus type signature, as per the
|
||||
* D-Bus specification.
|
||||
*/
|
||||
gboolean
|
||||
g_variant_serialiser_is_signature (gconstpointer data,
|
||||
|
@ -65,8 +65,8 @@
|
||||
* small constant time, usually touching only a single memory page.
|
||||
* Serialised #GVariant data can also be sent over the network.
|
||||
*
|
||||
* #GVariant is largely compatible with DBus. Almost all types of
|
||||
* #GVariant instances can be sent over DBus. See #GVariantType for
|
||||
* #GVariant is largely compatible with D-Bus. Almost all types of
|
||||
* #GVariant instances can be sent over D-Bus. See #GVariantType for
|
||||
* exceptions.
|
||||
*
|
||||
* For convenience to C programmers, #GVariant features powerful
|
||||
@ -540,8 +540,8 @@ NUMERIC_TYPE (UINT64, uint64, guint64)
|
||||
* Creates a new handle #GVariant instance.
|
||||
*
|
||||
* By convention, handles are indexes into an array of file descriptors
|
||||
* that are sent alongside a DBus message. If you're not interacting
|
||||
* with DBus, you probably don't need them.
|
||||
* that are sent alongside a D-Bus message. If you're not interacting
|
||||
* with D-Bus, you probably don't need them.
|
||||
*
|
||||
* Since: 2.24
|
||||
**/
|
||||
@ -556,8 +556,8 @@ NUMERIC_TYPE (UINT64, uint64, guint64)
|
||||
* than %G_VARIANT_TYPE_HANDLE.
|
||||
*
|
||||
* By convention, handles are indexes into an array of file descriptors
|
||||
* that are sent alongside a DBus message. If you're not interacting
|
||||
* with DBus, you probably don't need them.
|
||||
* that are sent alongside a D-Bus message. If you're not interacting
|
||||
* with D-Bus, you probably don't need them.
|
||||
*
|
||||
* Since: 2.24
|
||||
**/
|
||||
@ -1141,8 +1141,8 @@ g_variant_new_string (const gchar *string)
|
||||
* @object_path: a normal C nul-terminated string
|
||||
* @returns: a floating reference to a new object path #GVariant instance
|
||||
*
|
||||
* Creates a DBus object path #GVariant with the contents of @string.
|
||||
* @string must be a valid DBus object path. Use
|
||||
* Creates a D-Bus object path #GVariant with the contents of @string.
|
||||
* @string must be a valid D-Bus object path. Use
|
||||
* g_variant_is_object_path() if you're not sure.
|
||||
*
|
||||
* Since: 2.24
|
||||
@ -1159,10 +1159,10 @@ g_variant_new_object_path (const gchar *object_path)
|
||||
/**
|
||||
* g_variant_is_object_path:
|
||||
* @string: a normal C nul-terminated string
|
||||
* @returns: %TRUE if @string is a DBus object path
|
||||
* @returns: %TRUE if @string is a D-Bus object path
|
||||
*
|
||||
* Determines if a given string is a valid DBus object path. You
|
||||
* should ensure that a string is a valid DBus object path before
|
||||
* Determines if a given string is a valid D-Bus object path. You
|
||||
* should ensure that a string is a valid D-Bus object path before
|
||||
* passing it to g_variant_new_object_path().
|
||||
*
|
||||
* A valid object path starts with '/' followed by zero or more
|
||||
@ -1185,8 +1185,8 @@ g_variant_is_object_path (const gchar *string)
|
||||
* @signature: a normal C nul-terminated string
|
||||
* @returns: a floating reference to a new signature #GVariant instance
|
||||
*
|
||||
* Creates a DBus type signature #GVariant with the contents of
|
||||
* @string. @string must be a valid DBus type signature. Use
|
||||
* Creates a D-Bus type signature #GVariant with the contents of
|
||||
* @string. @string must be a valid D-Bus type signature. Use
|
||||
* g_variant_is_signature() if you're not sure.
|
||||
*
|
||||
* Since: 2.24
|
||||
@ -1203,13 +1203,13 @@ g_variant_new_signature (const gchar *signature)
|
||||
/**
|
||||
* g_variant_is_signature:
|
||||
* @string: a normal C nul-terminated string
|
||||
* @returns: %TRUE if @string is a DBus type signature
|
||||
* @returns: %TRUE if @string is a D-Bus type signature
|
||||
*
|
||||
* Determines if a given string is a valid DBus type signature. You
|
||||
* should ensure that a string is a valid DBus type signature before
|
||||
* Determines if a given string is a valid D-Bus type signature. You
|
||||
* should ensure that a string is a valid D-Bus type signature before
|
||||
* passing it to g_variant_new_signature().
|
||||
*
|
||||
* DBus type signatures consist of zero or more definite #GVariantType
|
||||
* D-Bus type signatures consist of zero or more definite #GVariantType
|
||||
* strings in sequence.
|
||||
*
|
||||
* Since: 2.24
|
||||
@ -1784,9 +1784,9 @@ g_variant_is_container (GVariant *value)
|
||||
* @G_VARIANT_CLASS_DOUBLE: The #GVariant is a double precision floating
|
||||
* point value.
|
||||
* @G_VARIANT_CLASS_STRING: The #GVariant is a normal string.
|
||||
* @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a DBus object path
|
||||
* @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a D-Bus object path
|
||||
* string.
|
||||
* @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a DBus signature string.
|
||||
* @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a D-Bus signature string.
|
||||
* @G_VARIANT_CLASS_VARIANT: The #GVariant is a variant.
|
||||
* @G_VARIANT_CLASS_MAYBE: The #GVariant is a maybe-typed value.
|
||||
* @G_VARIANT_CLASS_ARRAY: The #GVariant is an array.
|
||||
|
@ -37,13 +37,13 @@
|
||||
* @see_also: #GVariantType, #GVariant
|
||||
*
|
||||
* This section introduces the GVariant type system. It is based, in
|
||||
* large part, on the DBus type system, with two major changes and some minor
|
||||
* large part, on the D-Bus type system, with two major changes and some minor
|
||||
* lifting of restrictions. The <ulink
|
||||
* url='http://dbus.freedesktop.org/doc/dbus-specification.html'>DBus
|
||||
* specification</ulink>, therefore, provides a significant amount of
|
||||
* information that is useful when working with GVariant.
|
||||
*
|
||||
* The first major change with respect to the DBus type system is the
|
||||
* The first major change with respect to the D-Bus type system is the
|
||||
* introduction of maybe (or "nullable") types. Any type in GVariant can be
|
||||
* converted to a maybe type, in which case, "nothing" (or "null") becomes a
|
||||
* valid value. Maybe types have been added by introducing the
|
||||
@ -51,8 +51,8 @@
|
||||
*
|
||||
* The second major change is that the GVariant type system supports the
|
||||
* concept of "indefinite types" -- types that are less specific than
|
||||
* the normal types found in DBus. For example, it is possible to speak
|
||||
* of "an array of any type" in GVariant, where the DBus type system
|
||||
* the normal types found in D-Bus. For example, it is possible to speak
|
||||
* of "an array of any type" in GVariant, where the D-Bus type system
|
||||
* would require you to speak of "an array of integers" or "an array of
|
||||
* strings". Indefinite types have been added by introducing the
|
||||
* characters "<literal>*</literal>", "<literal>?</literal>" and
|
||||
@ -62,15 +62,15 @@
|
||||
* types are lifted along with the restriction that dictionary entries
|
||||
* may only appear nested inside of arrays.
|
||||
*
|
||||
* Just as in DBus, GVariant types are described with strings ("type
|
||||
* Just as in D-Bus, GVariant types are described with strings ("type
|
||||
* strings"). Subject to the differences mentioned above, these strings
|
||||
* are of the same form as those found in DBus. Note, however: DBus
|
||||
* are of the same form as those found in DBus. Note, however: D-Bus
|
||||
* always works in terms of messages and therefore individual type
|
||||
* strings appear nowhere in its interface. Instead, "signatures"
|
||||
* are a concatenation of the strings of the type of each argument in a
|
||||
* message. GVariant deals with single values directly so GVariant type
|
||||
* strings always describe the type of exactly one value. This means
|
||||
* that a DBus signature string is generally not a valid GVariant type
|
||||
* that a D-Bus signature string is generally not a valid GVariant type
|
||||
* string -- except in the case that it is the signature of a message
|
||||
* containing exactly one argument.
|
||||
*
|
||||
@ -282,7 +282,7 @@
|
||||
* <para>
|
||||
* the type string of %G_VARIANT_TYPE_HANDLE; a signed 32 bit
|
||||
* value that, by convention, is used as an index into an array
|
||||
* of file descriptors that are sent alongside a DBus message.
|
||||
* of file descriptors that are sent alongside a D-Bus message.
|
||||
* </para>
|
||||
* </entry>
|
||||
* </row>
|
||||
@ -320,7 +320,7 @@
|
||||
* <entry>
|
||||
* <para>
|
||||
* the type string of %G_VARIANT_TYPE_OBJECT_PATH; a string in
|
||||
* the form of a DBus object path.
|
||||
* the form of a D-Bus object path.
|
||||
* </para>
|
||||
* </entry>
|
||||
* </row>
|
||||
@ -333,7 +333,7 @@
|
||||
* <entry>
|
||||
* <para>
|
||||
* the type string of %G_VARIANT_TYPE_STRING; a string in the
|
||||
* form of a DBus type signature.
|
||||
* form of a D-Bus type signature.
|
||||
* </para>
|
||||
* </entry>
|
||||
* </row>
|
||||
|
@ -126,12 +126,12 @@ typedef struct _GVariantType GVariantType;
|
||||
/**
|
||||
* G_VARIANT_TYPE_OBJECT_PATH:
|
||||
*
|
||||
* The type of a DBus object reference. These are strings of a
|
||||
* The type of a D-Bus object reference. These are strings of a
|
||||
* specific format used to identify objects at a given destination on
|
||||
* the bus.
|
||||
*
|
||||
* If you are not interacting with DBus, then there is no reason to make
|
||||
* use of this type. If you are, then the DBus specification contains a
|
||||
* If you are not interacting with D-Bus, then there is no reason to make
|
||||
* use of this type. If you are, then the D-Bus specification contains a
|
||||
* precise description of valid object paths.
|
||||
**/
|
||||
#define G_VARIANT_TYPE_OBJECT_PATH ((const GVariantType *) "o")
|
||||
@ -139,11 +139,11 @@ typedef struct _GVariantType GVariantType;
|
||||
/**
|
||||
* G_VARIANT_TYPE_SIGNATURE:
|
||||
*
|
||||
* The type of a DBus type signature. These are strings of a specific
|
||||
* format used as type signatures for DBus methods and messages.
|
||||
* The type of a D-Bus type signature. These are strings of a specific
|
||||
* format used as type signatures for D-Bus methods and messages.
|
||||
*
|
||||
* If you are not interacting with DBus, then there is no reason to make
|
||||
* use of this type. If you are, then the DBus specification contains a
|
||||
* If you are not interacting with D-Bus, then there is no reason to make
|
||||
* use of this type. If you are, then the D-Bus specification contains a
|
||||
* precise description of valid signature strings.
|
||||
**/
|
||||
#define G_VARIANT_TYPE_SIGNATURE ((const GVariantType *) "g")
|
||||
@ -161,9 +161,9 @@ typedef struct _GVariantType GVariantType;
|
||||
*
|
||||
* The type of a 32bit signed integer value, that by convention, is used
|
||||
* as an index into an array of file descriptors that are sent alongside
|
||||
* a DBus message.
|
||||
* a D-Bus message.
|
||||
*
|
||||
* If you are not interacting with DBus, then there is no reason to make
|
||||
* If you are not interacting with D-Bus, then there is no reason to make
|
||||
* use of this type.
|
||||
**/
|
||||
#define G_VARIANT_TYPE_HANDLE ((const GVariantType *) "h")
|
||||
|
Loading…
Reference in New Issue
Block a user