EggDBusMessage

EggDBusMessage — Represents a D-Bus message

Functions

EggDBusMessage * egg_dbus_message_new_for_method_reply ()
EggDBusMessage * egg_dbus_message_new_for_method_error_reply ()
EggDBusConnection * egg_dbus_message_get_connection ()
EggDBusMessageType egg_dbus_message_get_message_type ()
const gchar * egg_dbus_message_get_object_path ()
const gchar * egg_dbus_message_get_interface_name ()
const gchar * egg_dbus_message_get_method_name ()
const gchar * egg_dbus_message_get_signal_name ()
EggDBusMessage * egg_dbus_message_get_in_reply_to ()
const gchar * egg_dbus_message_get_sender ()
const gchar * egg_dbus_message_get_destination ()
const gchar * egg_dbus_message_get_signature ()
gboolean egg_dbus_message_append_string ()
gboolean egg_dbus_message_append_string_array ()
gboolean egg_dbus_message_append_object_path ()
gboolean egg_dbus_message_append_object_path_array ()
gboolean egg_dbus_message_append_signature ()
gboolean egg_dbus_message_append_signature_array ()
gboolean egg_dbus_message_append_byte ()
gboolean egg_dbus_message_append_int16 ()
gboolean egg_dbus_message_append_uint16 ()
gboolean egg_dbus_message_append_int ()
gboolean egg_dbus_message_append_uint ()
gboolean egg_dbus_message_append_int64 ()
gboolean egg_dbus_message_append_uint64 ()
gboolean egg_dbus_message_append_boolean ()
gboolean egg_dbus_message_append_double ()
gboolean egg_dbus_message_append_seq ()
gboolean egg_dbus_message_append_map ()
gboolean egg_dbus_message_append_structure ()
gboolean egg_dbus_message_append_variant ()
gboolean egg_dbus_message_append_gvalue ()
gboolean egg_dbus_message_extract_string ()
gboolean egg_dbus_message_extract_string_array ()
gboolean egg_dbus_message_extract_object_path ()
gboolean egg_dbus_message_extract_object_path_array ()
gboolean egg_dbus_message_extract_signature ()
gboolean egg_dbus_message_extract_signature_array ()
gboolean egg_dbus_message_extract_byte ()
gboolean egg_dbus_message_extract_int16 ()
gboolean egg_dbus_message_extract_uint16 ()
gboolean egg_dbus_message_extract_int ()
gboolean egg_dbus_message_extract_uint ()
gboolean egg_dbus_message_extract_int64 ()
gboolean egg_dbus_message_extract_uint64 ()
gboolean egg_dbus_message_extract_boolean ()
gboolean egg_dbus_message_extract_double ()
gboolean egg_dbus_message_extract_seq ()
gboolean egg_dbus_message_extract_map ()
gboolean egg_dbus_message_extract_structure ()
gboolean egg_dbus_message_extract_variant ()
gboolean egg_dbus_message_extract_gvalue ()

Properties

EggDBusConnection * connection Read / Write / Construct Only
gchar * destination Read / Write / Construct Only
gchar * error-message Read / Write / Construct Only
gchar * error-name Read / Write / Construct Only
EggDBusMessage * in-reply-to Read / Write / Construct Only
gchar * interface-name Read / Write / Construct Only
EggDBusMessageType message-type Read / Write / Construct Only
gchar * method-name Read / Write / Construct Only
EggDBusObjectPath * object-path Read / Write / Construct Only
gchar * sender Read / Write / Construct Only
gchar * signal-name Read / Write / Construct Only
gchar * signature Read

Types and Values

Object Hierarchy

    GEnum
    ╰── EggDBusMessageType
    GObject
    ╰── EggDBusMessage

Description

The EggDBusMessage class is used for sending and receiving D-Bus messages. This class is only useful for language bindings.

Functions

egg_dbus_message_new_for_method_reply ()

EggDBusMessage *
egg_dbus_message_new_for_method_reply (EggDBusMessage *reply_to);

Creates a new message representing a reply to another message.

Parameters

reply_to

The message to reply to.

 

Returns

A EggDBusMessage. Free with g_object_unref().


egg_dbus_message_new_for_method_error_reply ()

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.

Parameters

reply_to

The message to reply to.

 

error_name

D-Bus error name.

 

error_message

D-Bus error message.

 

Returns

A EggDBusMessage. Free with g_object_unref().


egg_dbus_message_get_connection ()

EggDBusConnection *
egg_dbus_message_get_connection (EggDBusMessage *message);

Gets the connection that message is associated with.

Parameters

message

A EggDBusMessage.

 

Returns

The connection that message is associated with. Do not free, the connection is owned by message .


egg_dbus_message_get_message_type ()

EggDBusMessageType
egg_dbus_message_get_message_type (EggDBusMessage *message);

The type of the message.

Parameters

message

A EggDBusMessage.

 

Returns

A value from the EggDBusMessageType enumeration.


egg_dbus_message_get_object_path ()

const gchar *
egg_dbus_message_get_object_path (EggDBusMessage *message);

Gets the object path of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The object path of message . Do not free, the value is owned by message .


egg_dbus_message_get_interface_name ()

const gchar *
egg_dbus_message_get_interface_name (EggDBusMessage *message);

Gets the interface name of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The intername name of message . Do not free, the value is owned by message .


egg_dbus_message_get_method_name ()

const gchar *
egg_dbus_message_get_method_name (EggDBusMessage *message);

Gets the method name of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The method name of the message. Do not free, the value is owned by message .


egg_dbus_message_get_signal_name ()

const gchar *
egg_dbus_message_get_signal_name (EggDBusMessage *message);

Gets the signal name of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The signal name of the message. Do not free, the value is owned by message .


egg_dbus_message_get_in_reply_to ()

EggDBusMessage *
egg_dbus_message_get_in_reply_to (EggDBusMessage *message);

Gets the message that message is a reply to.

Parameters

message

A EggDBusMessage.

 

Returns

A EggDBusMessage. Do not free, the value is owned by message .


egg_dbus_message_get_sender ()

const gchar *
egg_dbus_message_get_sender (EggDBusMessage *message);

Gets the sender of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The sender of the message. Do not free, the value is owned by message .


egg_dbus_message_get_destination ()

const gchar *
egg_dbus_message_get_destination (EggDBusMessage *message);

Gets the destination of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The destination of the message. Do not free, the value is owned by message .


egg_dbus_message_get_signature ()

const gchar *
egg_dbus_message_get_signature (EggDBusMessage *message);

Gets the signature of the message.

Parameters

message

A EggDBusMessage.

 

Returns

The signature of the message. Do not free, the value is owned by message .


egg_dbus_message_append_string ()

gboolean
egg_dbus_message_append_string (EggDBusMessage *message,
                                const gchar *value,
                                GError **error);

Appends a string to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_string_array ()

gboolean
egg_dbus_message_append_string_array (EggDBusMessage *message,
                                      gchar **value,
                                      GError **error);

Appends a NULL-terminated string array to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_object_path ()

gboolean
egg_dbus_message_append_object_path (EggDBusMessage *message,
                                     const gchar *value,
                                     GError **error);

Appends an object path to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_object_path_array ()

gboolean
egg_dbus_message_append_object_path_array
                               (EggDBusMessage *message,
                                gchar **value,
                                GError **error);

Appends a NULL-terminated object path array to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_signature ()

gboolean
egg_dbus_message_append_signature (EggDBusMessage *message,
                                   const gchar *value,
                                   GError **error);

Appends a D-Bus signature to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_signature_array ()

gboolean
egg_dbus_message_append_signature_array
                               (EggDBusMessage *message,
                                gchar **value,
                                GError **error);

Appends a NULL-terminated D-Bus signature array to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_byte ()

gboolean
egg_dbus_message_append_byte (EggDBusMessage *message,
                              guchar value,
                              GError **error);

Appends a guchar to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_int16 ()

gboolean
egg_dbus_message_append_int16 (EggDBusMessage *message,
                               gint16 value,
                               GError **error);

Appends a gint16 to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_uint16 ()

gboolean
egg_dbus_message_append_uint16 (EggDBusMessage *message,
                                guint16 value,
                                GError **error);

Appends a guint16 to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_int ()

gboolean
egg_dbus_message_append_int (EggDBusMessage *message,
                             gint value,
                             GError **error);

Appends a gint to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_uint ()

gboolean
egg_dbus_message_append_uint (EggDBusMessage *message,
                              guint value,
                              GError **error);

Appends a guint to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_int64 ()

gboolean
egg_dbus_message_append_int64 (EggDBusMessage *message,
                               gint64 value,
                               GError **error);

Appends a gint64 to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_uint64 ()

gboolean
egg_dbus_message_append_uint64 (EggDBusMessage *message,
                                guint64 value,
                                GError **error);

Appends a guint64 to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_boolean ()

gboolean
egg_dbus_message_append_boolean (EggDBusMessage *message,
                                 gboolean value,
                                 GError **error);

Appends a gboolean to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_double ()

gboolean
egg_dbus_message_append_double (EggDBusMessage *message,
                                gdouble value,
                                GError **error);

Appends a gdouble to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_seq ()

gboolean
egg_dbus_message_append_seq (EggDBusMessage *message,
                             EggDBusArraySeq *seq,
                             const gchar *element_signature,
                             GError **error);

Appends a EggDBusSeq to message .

Parameters

message

A EggDBusMessage.

 

seq

Sequence to append to message .

 

element_signature

D-Bus signature of elements in seq .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_map ()

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 .

Parameters

message

A EggDBusMessage.

 

map

Map to append to message .

 

key_signature

D-Bus signature of keys in map .

 

value_signature

D-Bus signature of values in map .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_structure ()

gboolean
egg_dbus_message_append_structure (EggDBusMessage *message,
                                   EggDBusStructure *structure,
                                   GError **error);

Appends a EggDBusStructure to message .

Parameters

message

A EggDBusMessage.

 

structure

Structure to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_variant ()

gboolean
egg_dbus_message_append_variant (EggDBusMessage *message,
                                 EggDBusVariant *variant,
                                 GError **error);

Appends a EggDBusVariant to message .

Parameters

message

A EggDBusMessage.

 

variant

Variant to append to message .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_append_gvalue ()

gboolean
egg_dbus_message_append_gvalue (EggDBusMessage *message,
                                const GValue *value,
                                const gchar *signature,
                                GError **error);

Appends a GValue to message .

Parameters

message

A EggDBusMessage.

 

value

Value to append to message .

 

signature

D-Bus signature of value .

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_string ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_string_array ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_object_path ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_object_path_array ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_signature ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_signature_array ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_byte ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_int16 ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_uint16 ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_int ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_uint ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_int64 ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_uint64 ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_boolean ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_double ()

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.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_seq ()

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.

Parameters

message

A EggDBusMessage.

 

out_seq

Return location for extracted sequence or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_map ()

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.

Parameters

message

A EggDBusMessage.

 

out_map

Return location for extracted map or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_structure ()

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.

Parameters

message

A EggDBusMessage.

 

out_structure

Return location for extracted structure or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_variant ()

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.

Parameters

message

A EggDBusMessage.

 

out_variant

Return location for extracted variant or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.


egg_dbus_message_extract_gvalue ()

gboolean
egg_dbus_message_extract_gvalue (EggDBusMessage *message,
                                 GValue *out_value,
                                 GError **error);

Extracts the next complete complete type from message as a GValue.

Parameters

message

A EggDBusMessage.

 

out_value

Return location for extracted value or NULL.

 

error

Return location for error.

 

Returns

TRUE unless error is set.

Types and Values

EggDBusMessage

typedef struct _EggDBusMessage EggDBusMessage;

enum EggDBusMessageType

Members

EGG_DBUS_MESSAGE_TYPE_METHOD_CALL

   

EGG_DBUS_MESSAGE_TYPE_METHOD_REPLY

   

EGG_DBUS_MESSAGE_TYPE_METHOD_ERROR_REPLY

   

EGG_DBUS_MESSAGE_TYPE_SIGNAL

   

Property Details

The “connection” property

  “connection”               EggDBusConnection *

The connection this message is for.

Flags: Read / Write / Construct Only


The “destination” property

  “destination”              gchar *

The destination of the message.

Flags: Read / Write / Construct Only

Default value: NULL


The “error-message” property

  “error-message”            gchar *

The error message.

Flags: Read / Write / Construct Only

Default value: NULL


The “error-name” property

  “error-name”               gchar *

The error name.

Flags: Read / Write / Construct Only

Default value: NULL


The “in-reply-to” property

  “in-reply-to”              EggDBusMessage *

The message this is a reply to.

Flags: Read / Write / Construct Only


The “interface-name” property

  “interface-name”           gchar *

The name of the interface.

Flags: Read / Write / Construct Only

Default value: NULL


The “message-type” property

  “message-type”             EggDBusMessageType

The type of the message.

Flags: Read / Write / Construct Only

Default value: EGG_DBUS_MESSAGE_TYPE_METHOD_CALL


The “method-name” property

  “method-name”              gchar *

The name of the method.

Flags: Read / Write / Construct Only

Default value: NULL


The “object-path” property

  “object-path”              EggDBusObjectPath *

The object path.

Flags: Read / Write / Construct Only


The “sender” property

  “sender”                   gchar *

The name of who sent the message.

Flags: Read / Write / Construct Only

Default value: NULL


The “signal-name” property

  “signal-name”              gchar *

The name of the signal.

Flags: Read / Write / Construct Only

Default value: NULL


The “signature” property

  “signature”                gchar *

The signature of the message.

Flags: Read

Default value: NULL