| EggDBus Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
EggDBusMessage;
enum EggDBusMessageType;
EggDBusMessage * egg_dbus_message_new_for_method_reply
(EggDBusMessage *reply_to);
EggDBusMessage * egg_dbus_message_new_for_method_error_reply
(EggDBusMessage *reply_to,
const gchar *error_name,
const gchar *error_message);
EggDBusConnection * egg_dbus_message_get_connection (EggDBusMessage *message);
EggDBusMessageType egg_dbus_message_get_message_type (EggDBusMessage *message);
const gchar * egg_dbus_message_get_object_path (EggDBusMessage *message);
const gchar * egg_dbus_message_get_interface_name (EggDBusMessage *message);
const gchar * egg_dbus_message_get_method_name (EggDBusMessage *message);
const gchar * egg_dbus_message_get_signal_name (EggDBusMessage *message);
EggDBusMessage * egg_dbus_message_get_in_reply_to (EggDBusMessage *message);
const gchar * egg_dbus_message_get_sender (EggDBusMessage *message);
const gchar * egg_dbus_message_get_destination (EggDBusMessage *message);
const gchar * egg_dbus_message_get_signature (EggDBusMessage *message);
gboolean egg_dbus_message_append_string (EggDBusMessage *message,
const gchar *value,
GError **error);
gboolean egg_dbus_message_append_string_array
(EggDBusMessage *message,
gchar **value,
GError **error);
gboolean egg_dbus_message_append_object_path (EggDBusMessage *message,
const gchar *value,
GError **error);
gboolean egg_dbus_message_append_object_path_array
(EggDBusMessage *message,
gchar **value,
GError **error);
gboolean egg_dbus_message_append_signature (EggDBusMessage *message,
const gchar *value,
GError **error);
gboolean egg_dbus_message_append_signature_array
(EggDBusMessage *message,
gchar **value,
GError **error);
gboolean egg_dbus_message_append_byte (EggDBusMessage *message,
guchar value,
GError **error);
gboolean egg_dbus_message_append_int16 (EggDBusMessage *message,
gint16 value,
GError **error);
gboolean egg_dbus_message_append_uint16 (EggDBusMessage *message,
guint16 value,
GError **error);
gboolean egg_dbus_message_append_int (EggDBusMessage *message,
gint value,
GError **error);
gboolean egg_dbus_message_append_uint (EggDBusMessage *message,
guint value,
GError **error);
gboolean egg_dbus_message_append_int64 (EggDBusMessage *message,
gint64 value,
GError **error);
gboolean egg_dbus_message_append_uint64 (EggDBusMessage *message,
guint64 value,
GError **error);
gboolean egg_dbus_message_append_boolean (EggDBusMessage *message,
gboolean value,
GError **error);
gboolean egg_dbus_message_append_double (EggDBusMessage *message,
gdouble value,
GError **error);
gboolean egg_dbus_message_append_seq (EggDBusMessage *message,
EggDBusArraySeq *seq,
const gchar *element_signature,
GError **error);
gboolean egg_dbus_message_append_map (EggDBusMessage *message,
EggDBusHashMap *map,
const gchar *key_signature,
const gchar *value_signature,
GError **error);
gboolean egg_dbus_message_append_structure (EggDBusMessage *message,
EggDBusStructure *structure,
GError **error);
gboolean egg_dbus_message_append_variant (EggDBusMessage *message,
EggDBusVariant *variant,
GError **error);
gboolean egg_dbus_message_append_gvalue (EggDBusMessage *message,
const GValue *value,
const gchar *signature,
GError **error);
gboolean egg_dbus_message_extract_string (EggDBusMessage *message,
gchar **out_value,
GError **error);
gboolean egg_dbus_message_extract_string_array
(EggDBusMessage *message,
gchar ***out_value,
GError **error);
gboolean egg_dbus_message_extract_object_path
(EggDBusMessage *message,
gchar **out_value,
GError **error);
gboolean egg_dbus_message_extract_object_path_array
(EggDBusMessage *message,
gchar ***out_value,
GError **error);
gboolean egg_dbus_message_extract_signature (EggDBusMessage *message,
gchar **out_value,
GError **error);
gboolean egg_dbus_message_extract_signature_array
(EggDBusMessage *message,
gchar ***out_value,
GError **error);
gboolean egg_dbus_message_extract_byte (EggDBusMessage *message,
guchar *out_value,
GError **error);
gboolean egg_dbus_message_extract_int16 (EggDBusMessage *message,
gint16 *out_value,
GError **error);
gboolean egg_dbus_message_extract_uint16 (EggDBusMessage *message,
guint16 *out_value,
GError **error);
gboolean egg_dbus_message_extract_int (EggDBusMessage *message,
gint *out_value,
GError **error);
gboolean egg_dbus_message_extract_uint (EggDBusMessage *message,
guint *out_value,
GError **error);
gboolean egg_dbus_message_extract_int64 (EggDBusMessage *message,
gint64 *out_value,
GError **error);
gboolean egg_dbus_message_extract_uint64 (EggDBusMessage *message,
guint64 *out_value,
GError **error);
gboolean egg_dbus_message_extract_boolean (EggDBusMessage *message,
gboolean *out_value,
GError **error);
gboolean egg_dbus_message_extract_double (EggDBusMessage *message,
gdouble *out_value,
GError **error);
gboolean egg_dbus_message_extract_seq (EggDBusMessage *message,
EggDBusArraySeq **out_seq,
GError **error);
gboolean egg_dbus_message_extract_map (EggDBusMessage *message,
EggDBusHashMap **out_map,
GError **error);
gboolean egg_dbus_message_extract_structure (EggDBusMessage *message,
EggDBusStructure **out_structure,
GError **error);
gboolean egg_dbus_message_extract_variant (EggDBusMessage *message,
EggDBusVariant **out_variant,
GError **error);
gboolean egg_dbus_message_extract_gvalue (EggDBusMessage *message,
GValue *out_value,
GError **error);
"connection" EggDBusConnection* : Read / Write / Construct Only "destination" gchar* : Read / Write / Construct Only "error-message" gchar* : Read / Write / Construct Only "error-name" gchar* : Read / Write / Construct Only "in-reply-to" EggDBusMessage* : Read / Write / Construct Only "interface-name" gchar* : Read / Write / Construct Only "message-type" EggDBusMessageType : Read / Write / Construct Only "method-name" gchar* : Read / Write / Construct Only "object-path" EggDBusObjectPath* : Read / Write / Construct Only "sender" gchar* : Read / Write / Construct Only "signal-name" gchar* : Read / Write / Construct Only "signature" gchar* : Read
The EggDBusMessage class is used for sending and receiving D-Bus messages. This class is only useful for language bindings.
typedef enum {
EGG_DBUS_MESSAGE_TYPE_METHOD_CALL,
EGG_DBUS_MESSAGE_TYPE_METHOD_REPLY,
EGG_DBUS_MESSAGE_TYPE_METHOD_ERROR_REPLY,
EGG_DBUS_MESSAGE_TYPE_SIGNAL,
} EggDBusMessageType;
EggDBusMessage * egg_dbus_message_new_for_method_reply (EggDBusMessage *reply_to);
Creates a new message representing a reply to another message.
|
The message to reply to. |
Returns : |
A EggDBusMessage. Free with g_object_unref().
|
EggDBusMessage * egg_dbus_message_new_for_method_error_reply (EggDBusMessage *reply_to, const gchar *error_name, const gchar *error_message);
Creates a new error message in reply to another message.
|
The message to reply to. |
|
D-Bus error name. |
|
D-Bus error message. |
Returns : |
A EggDBusMessage. Free with g_object_unref().
|
EggDBusConnection * egg_dbus_message_get_connection (EggDBusMessage *message);
Gets the connection that message is associated with.
|
A EggDBusMessage. |
Returns : |
The connection that message is associated with. Do not free, the connection is owned by message.
|
EggDBusMessageType egg_dbus_message_get_message_type (EggDBusMessage *message);
The type of the message.
|
A EggDBusMessage. |
Returns : |
A value from the EggDBusMessageType enumeration. |
const gchar * egg_dbus_message_get_object_path (EggDBusMessage *message);
Gets the object path of the message.
|
A EggDBusMessage. |
Returns : |
The object path of message. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_interface_name (EggDBusMessage *message);
Gets the interface name of the message.
|
A EggDBusMessage. |
Returns : |
The intername name of message. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_method_name (EggDBusMessage *message);
Gets the method name of the message.
|
A EggDBusMessage. |
Returns : |
The method name of the message. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_signal_name (EggDBusMessage *message);
Gets the signal name of the message.
|
A EggDBusMessage. |
Returns : |
The signal name of the message. Do not free, the value is owned by message.
|
EggDBusMessage * egg_dbus_message_get_in_reply_to (EggDBusMessage *message);
Gets the message that message is a reply to.
|
A EggDBusMessage. |
Returns : |
A EggDBusMessage. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_sender (EggDBusMessage *message);
Gets the sender of the message.
|
A EggDBusMessage. |
Returns : |
The sender of the message. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_destination (EggDBusMessage *message);
Gets the destination of the message.
|
A EggDBusMessage. |
Returns : |
The destination of the message. Do not free, the value is owned by message.
|
const gchar * egg_dbus_message_get_signature (EggDBusMessage *message);
Gets the signature of the message.
|
A EggDBusMessage. |
Returns : |
The signature of the message. Do not free, the value is owned by message.
|
gboolean egg_dbus_message_append_string (EggDBusMessage *message, const gchar *value, GError **error);
Appends a string to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_string_array (EggDBusMessage *message, gchar **value, GError **error);
Appends a NULL-terminated string array to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_object_path (EggDBusMessage *message, const gchar *value, GError **error);
Appends an object path to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_object_path_array (EggDBusMessage *message, gchar **value, GError **error);
Appends a NULL-terminated object path array to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_signature (EggDBusMessage *message, const gchar *value, GError **error);
Appends a D-Bus signature to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_signature_array (EggDBusMessage *message, gchar **value, GError **error);
Appends a NULL-terminated D-Bus signature array to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_byte (EggDBusMessage *message, guchar value, GError **error);
Appends a guchar to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_int16 (EggDBusMessage *message, gint16 value, GError **error);
Appends a gint16 to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_uint16 (EggDBusMessage *message, guint16 value, GError **error);
Appends a guint16 to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_int (EggDBusMessage *message, gint value, GError **error);
Appends a gint to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_uint (EggDBusMessage *message, guint value, GError **error);
Appends a guint to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_int64 (EggDBusMessage *message, gint64 value, GError **error);
Appends a gint64 to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_uint64 (EggDBusMessage *message, guint64 value, GError **error);
Appends a guint64 to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_boolean (EggDBusMessage *message, gboolean value, GError **error);
Appends a gboolean to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_double (EggDBusMessage *message, gdouble value, GError **error);
Appends a gdouble to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_seq (EggDBusMessage *message, EggDBusArraySeq *seq, const gchar *element_signature, GError **error);
Appends a EggDBusSeq to message.
|
A EggDBusMessage. |
|
Sequence to append to message.
|
|
D-Bus signature of elements in seq.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_map (EggDBusMessage *message, EggDBusHashMap *map, const gchar *key_signature, const gchar *value_signature, GError **error);
Appends a EggDBusMap to message.
|
A EggDBusMessage. |
|
Map to append to message.
|
|
D-Bus signature of keys in map.
|
|
D-Bus signature of values in map.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_structure (EggDBusMessage *message, EggDBusStructure *structure, GError **error);
Appends a EggDBusStructure to message.
|
A EggDBusMessage. |
|
Structure to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_variant (EggDBusMessage *message, EggDBusVariant *variant, GError **error);
Appends a EggDBusVariant to message.
|
A EggDBusMessage. |
|
Variant to append to message.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_append_gvalue (EggDBusMessage *message, const GValue *value, const gchar *signature, GError **error);
Appends a GValue to message.
|
A EggDBusMessage. |
|
Value to append to message.
|
|
D-Bus signature of value.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_string (EggDBusMessage *message, gchar **out_value, GError **error);
Extracts a string from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_string_array (EggDBusMessage *message, gchar ***out_value, GError **error);
Extracts an array of strings from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_object_path (EggDBusMessage *message, gchar **out_value, GError **error);
Extracts an object path from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_object_path_array (EggDBusMessage *message, gchar ***out_value, GError **error);
Extracts an array of object paths from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_signature (EggDBusMessage *message, gchar **out_value, GError **error);
Extracts a D-Bus signature from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_signature_array (EggDBusMessage *message, gchar ***out_value, GError **error);
Extracts an array of D-Bus signatures from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_byte (EggDBusMessage *message, guchar *out_value, GError **error);
Extracts a guchar from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_int16 (EggDBusMessage *message, gint16 *out_value, GError **error);
Extracts a gint16 from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_uint16 (EggDBusMessage *message, guint16 *out_value, GError **error);
Extracts a guint16 from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_int (EggDBusMessage *message, gint *out_value, GError **error);
Extracts a gint from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_uint (EggDBusMessage *message, guint *out_value, GError **error);
Extracts a guint from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_int64 (EggDBusMessage *message, gint64 *out_value, GError **error);
Extracts a gint64 from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_uint64 (EggDBusMessage *message, guint64 *out_value, GError **error);
Extracts a guint64 from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_boolean (EggDBusMessage *message, gboolean *out_value, GError **error);
Extracts a gboolean from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_double (EggDBusMessage *message, gdouble *out_value, GError **error);
Extracts a gdouble from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_seq (EggDBusMessage *message, EggDBusArraySeq **out_seq, GError **error);
Extracts a EggDBusSequence from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted sequence or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_map (EggDBusMessage *message, EggDBusHashMap **out_map, GError **error);
Extracts a EggDBusHashMap from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted map or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_structure (EggDBusMessage *message, EggDBusStructure **out_structure, GError **error);
Extracts a EggDBusStructure from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted structure or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_variant (EggDBusMessage *message, EggDBusVariant **out_variant, GError **error);
Extracts a EggDBusVariant from message and moves on to the next element.
|
A EggDBusMessage. |
|
Return location for extracted variant or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
gboolean egg_dbus_message_extract_gvalue (EggDBusMessage *message, GValue *out_value, GError **error);
Extracts the next complete complete type from message as a GValue.
|
A EggDBusMessage. |
|
Return location for extracted value or NULL.
|
|
Return location for error. |
Returns : |
TRUE unless error is set.
|
"connection" property"connection" EggDBusConnection* : Read / Write / Construct Only
The connection this message is for.
"destination" property"destination" gchar* : Read / Write / Construct Only
The destination of the message.
Default value: NULL
"error-message" property"error-message" gchar* : Read / Write / Construct Only
The error message.
Default value: NULL
"error-name" property"error-name" gchar* : Read / Write / Construct Only
The error name.
Default value: NULL
"in-reply-to" property"in-reply-to" EggDBusMessage* : Read / Write / Construct Only
The message this is a reply to.
"interface-name" property"interface-name" gchar* : Read / Write / Construct Only
The name of the interface.
Default value: NULL
"message-type" property"message-type" EggDBusMessageType : Read / Write / Construct Only
The type of the message.
Default value: EGG_DBUS_MESSAGE_TYPE_METHOD_CALL
"method-name" property"method-name" gchar* : Read / Write / Construct Only
The name of the method.
Default value: NULL
"object-path" property"object-path" EggDBusObjectPath* : Read / Write / Construct Only
The object path.
"sender" property"sender" gchar* : Read / Write / Construct Only
The name of who sent the message.
Default value: NULL
"signal-name" property"signal-name" gchar* : Read / Write / Construct Only
The name of the signal.
Default value: NULL
"signature" property"signature" gchar* : Read
The signature of the message.
Default value: NULL