DBusMessage

A type for representing D-Bus messages that can be sent or received on a gio.dbus_connection.DBusConnection.

class DBusMessage : ObjectG {}

Constructors

this
this()

Creates a new empty #GDBusMessage.

Members

Functions

copy
gio.dbus_message.DBusMessage copy()

Copies message. The copy is a deep copy and the returned #GDBusMessage is completely identical except that it is guaranteed to not be locked.

getArg0
string getArg0()

Convenience to get the first item in the body of message.

getArg0Path
string getArg0Path()

Convenience to get the first item in the body of message.

getBody
glib.variant.VariantG getBody()

Gets the body of a message.

getByteOrder
gio.types.DBusMessageByteOrder getByteOrder()

Gets the byte order of message.

getDestination
string getDestination()

Convenience getter for the gio.types.DBusMessageHeaderField.Destination header field.

getErrorName
string getErrorName()

Convenience getter for the gio.types.DBusMessageHeaderField.ErrorName header field.

getFlags
gio.types.DBusMessageFlags getFlags()

Gets the flags for message.

getHeader
glib.variant.VariantG getHeader(gio.types.DBusMessageHeaderField headerField)

Gets a header field on message.

getHeaderFields
ubyte[] getHeaderFields()

Gets an array of all header fields on message that are set.

getInterface
string getInterface()

Convenience getter for the gio.types.DBusMessageHeaderField.Interface header field.

getLocked
bool getLocked()

Checks whether message is locked. To monitor changes to this value, conncet to the #GObject::notify signal to listen for changes on the #GDBusMessage:locked property.

getMember
string getMember()

Convenience getter for the gio.types.DBusMessageHeaderField.Member header field.

getMessageType
gio.types.DBusMessageType getMessageType()

Gets the type of message.

getNumUnixFds
uint getNumUnixFds()

Convenience getter for the gio.types.DBusMessageHeaderField.NumUnixFds header field.

getPath
string getPath()

Convenience getter for the gio.types.DBusMessageHeaderField.Path header field.

getReplySerial
uint getReplySerial()

Convenience getter for the gio.types.DBusMessageHeaderField.ReplySerial header field.

getSender
string getSender()

Convenience getter for the gio.types.DBusMessageHeaderField.Sender header field.

getSerial
uint getSerial()

Gets the serial for message.

getSignature
string getSignature()

Convenience getter for the gio.types.DBusMessageHeaderField.Signature header field.

getUnixFdList
gio.unix_fdlist.UnixFDList getUnixFdList()

Gets the UNIX file descriptors associated with message, if any.

lock
void lock()

If message is locked, does nothing. Otherwise locks the message.

newMethodErrorLiteral
gio.dbus_message.DBusMessage newMethodErrorLiteral(string errorName, string errorMessage)

Creates a new #GDBusMessage that is an error reply to method_call_message.

newMethodReply
gio.dbus_message.DBusMessage newMethodReply()

Creates a new #GDBusMessage that is a reply to method_call_message.

print
string print(uint indent)

Produces a human-readable multi-line description of message.

setBody
void setBody(glib.variant.VariantG body_)

Sets the body message. As a side-effect the gio.types.DBusMessageHeaderField.Signature header field is set to the type string of body (or cleared if body is null).

setByteOrder
void setByteOrder(gio.types.DBusMessageByteOrder byteOrder)

Sets the byte order of message.

setDestination
void setDestination(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Destination header field.

setErrorName
void setErrorName(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.ErrorName header field.

setFlags
void setFlags(gio.types.DBusMessageFlags flags)

Sets the flags to set on message.

setHeader
void setHeader(gio.types.DBusMessageHeaderField headerField, glib.variant.VariantG value)

Sets a header field on message.

setInterface
void setInterface(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Interface header field.

setMember
void setMember(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Member header field.

setMessageType
void setMessageType(gio.types.DBusMessageType type)

Sets message to be of type.

setNumUnixFds
void setNumUnixFds(uint value)

Convenience setter for the gio.types.DBusMessageHeaderField.NumUnixFds header field.

setPath
void setPath(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Path header field.

setReplySerial
void setReplySerial(uint value)

Convenience setter for the gio.types.DBusMessageHeaderField.ReplySerial header field.

setSender
void setSender(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Sender header field.

setSerial
void setSerial(uint serial)

Sets the serial for message.

setSignature
void setSignature(string value)

Convenience setter for the gio.types.DBusMessageHeaderField.Signature header field.

setUnixFdList
void setUnixFdList(gio.unix_fdlist.UnixFDList fdList)

Sets the UNIX file descriptors associated with message. As a side-effect the gio.types.DBusMessageHeaderField.NumUnixFds header field is set to the number of fds in fd_list (or cleared if fd_list is null).

toBlob
ubyte[] toBlob(gio.types.DBusCapabilityFlags capabilities)

Serializes message to a blob. The byte order returned by gio.dbus_message.DBusMessage.getByteOrder will be used.

toGerror
bool toGerror()

If message is not of type gio.types.DBusMessageType.Error does nothing and returns false.

Static functions

bytesNeeded
ptrdiff_t bytesNeeded(ubyte[] blob)

Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob.

newFromBlob
gio.dbus_message.DBusMessage newFromBlob(ubyte[] blob, gio.types.DBusCapabilityFlags capabilities)

Creates a new #GDBusMessage from the data stored at blob. The byte order that the message was in can be retrieved using gio.dbus_message.DBusMessage.getByteOrder.

newMethodCall
gio.dbus_message.DBusMessage newMethodCall(string name, string path, string interface_, string method)

Creates a new #GDBusMessage for a method call.

newSignal
gio.dbus_message.DBusMessage newSignal(string path, string interface_, string signal)

Creates a new #GDBusMessage for a signal emission.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.