Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gio.Objects.DBusMessage

Contents

Exported types
Methods
Properties
- locked

Description

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

Synopsis

Exported types

newtype DBusMessage Source #

Constructors

DBusMessage (ManagedPtr DBusMessage)

Instances

GObject DBusMessage Source #
Methods gobjectType :: DBusMessage -> IO GType #
IsObject DBusMessage Source #

IsDBusMessage DBusMessage Source #

((~) * info (ResolveDBusMessageMethod t DBusMessage), MethodInfo * info DBusMessage p) => IsLabel t (DBusMessage -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> DBusMessage -> p #
((~) * info (ResolveDBusMessageMethod t DBusMessage), MethodInfo * info DBusMessage p) => IsLabelProxy t (DBusMessage -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> DBusMessage -> p #
HasAttributeList * DBusMessage Source #

type AttributeList DBusMessage Source #
type AttributeList DBusMessage
type SignalList DBusMessage Source #
type SignalList DBusMessage

class GObject o => IsDBusMessage o Source #

Instances

(GObject a, UnknownAncestorError Constraint DBusMessage a) => IsDBusMessage a Source #

IsDBusMessage DBusMessage Source #

toDBusMessage :: IsDBusMessage o => o -> IO DBusMessage Source #

noDBusMessage :: Maybe DBusMessage Source #

Methods

bytesNeeded

dBusMessageBytesNeeded Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteString	`blob`: A blob represent a binary D-Bus message.
-> m Int64	Returns: Number of bytes needed or -1 if `error` is set (e.g. if `blob` contains invalid data or not enough data is available to determine the size). (Can throw `GError`)

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

Since: 2.26

copy

data DBusMessageCopyMethodInfo Source #

Instances

((~) * signature (m DBusMessage), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageCopyMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageCopyMethodInfo a -> signature -> s #

dBusMessageCopy Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m DBusMessage	Returns: A new `DBusMessage` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

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

This operation can fail if e.g. message contains file descriptors and the per-process or system-wide open files limit is reached.

Since: 2.26

getArg0

data DBusMessageGetArg0MethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetArg0MethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetArg0MethodInfo a -> signature -> s #

dBusMessageGetArg0 Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The string item or `Nothing` if the first item in the body of `message` is not a string.

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

Since: 2.26

getBody

data DBusMessageGetBodyMethodInfo Source #

Instances

((~) * signature (m GVariant), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetBodyMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetBodyMethodInfo a -> signature -> s #

dBusMessageGetBody Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m GVariant	Returns: A `GVariant` or `Nothing` if the body is empty. Do not free, it is owned by `message`.

Gets the body of a message.

Since: 2.26

getByteOrder

data DBusMessageGetByteOrderMethodInfo Source #

Instances

((~) * signature (m DBusMessageByteOrder), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetByteOrderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetByteOrderMethodInfo a -> signature -> s #

dBusMessageGetByteOrder Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m DBusMessageByteOrder	Returns: The byte order.

Gets the byte order of message.

getDestination

data DBusMessageGetDestinationMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetDestinationMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetDestinationMethodInfo a -> signature -> s #

dBusMessageGetDestination Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldDestination header field.

Since: 2.26

getErrorName

data DBusMessageGetErrorNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetErrorNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetErrorNameMethodInfo a -> signature -> s #

dBusMessageGetErrorName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldErrorName header field.

Since: 2.26

getFlags

data DBusMessageGetFlagsMethodInfo Source #

Instances

((~) * signature (m [DBusMessageFlags]), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetFlagsMethodInfo a -> signature -> s #

dBusMessageGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m [DBusMessageFlags]	Returns: Flags that are set (typically values from the `DBusMessageFlags` enumeration bitwise ORed together).

Gets the flags for message.

Since: 2.26

getHeader

data DBusMessageGetHeaderMethodInfo Source #

Instances

((~) * signature (DBusMessageHeaderField -> m GVariant), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetHeaderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetHeaderMethodInfo a -> signature -> s #

dBusMessageGetHeader Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageHeaderField	`headerField`: A 8-bit unsigned integer (typically a value from the `DBusMessageHeaderField` enumeration)
-> m GVariant	Returns: A `GVariant` with the value if the header was found, `Nothing` otherwise. Do not free, it is owned by `message`.

Gets a header field on message.

Since: 2.26

getHeaderFields

data DBusMessageGetHeaderFieldsMethodInfo Source #

Instances

((~) * signature (m ByteString), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetHeaderFieldsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetHeaderFieldsMethodInfo a -> signature -> s #

dBusMessageGetHeaderFields Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ByteString	Returns: An array of header fields terminated by `DBusMessageHeaderFieldInvalid`. Each element is a `guchar`. Free with `free`.

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

Since: 2.26

getInterface

data DBusMessageGetInterfaceMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetInterfaceMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetInterfaceMethodInfo a -> signature -> s #

dBusMessageGetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldInterface header field.

Since: 2.26

getLocked

data DBusMessageGetLockedMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetLockedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetLockedMethodInfo a -> signature -> s #

dBusMessageGetLocked Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Bool	Returns: `True` if `message` is locked, `False` otherwise.

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

Since: 2.26

getMember

data DBusMessageGetMemberMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetMemberMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetMemberMethodInfo a -> signature -> s #

dBusMessageGetMember Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldMember header field.

Since: 2.26

getMessageType

data DBusMessageGetMessageTypeMethodInfo Source #

Instances

((~) * signature (m DBusMessageType), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetMessageTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetMessageTypeMethodInfo a -> signature -> s #

dBusMessageGetMessageType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m DBusMessageType	Returns: A 8-bit unsigned integer (typically a value from the `DBusMessageType` enumeration).

Gets the type of message.

Since: 2.26

getNumUnixFds

data DBusMessageGetNumUnixFdsMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetNumUnixFdsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetNumUnixFdsMethodInfo a -> signature -> s #

dBusMessageGetNumUnixFds Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldNumUnixFds header field.

Since: 2.26

getPath

data DBusMessageGetPathMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetPathMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetPathMethodInfo a -> signature -> s #

dBusMessageGetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldPath header field.

Since: 2.26

getReplySerial

data DBusMessageGetReplySerialMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetReplySerialMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetReplySerialMethodInfo a -> signature -> s #

dBusMessageGetReplySerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldReplySerial header field.

Since: 2.26

getSender

data DBusMessageGetSenderMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetSenderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetSenderMethodInfo a -> signature -> s #

dBusMessageGetSender Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldSender header field.

Since: 2.26

getSerial

data DBusMessageGetSerialMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetSerialMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetSerialMethodInfo a -> signature -> s #

dBusMessageGetSerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Word32	Returns: A `guint32`.

Gets the serial for message.

Since: 2.26

getSignature

data DBusMessageGetSignatureMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetSignatureMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetSignatureMethodInfo a -> signature -> s #

dBusMessageGetSignature Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m Text	Returns: The value.

Convenience getter for the DBusMessageHeaderFieldSignature header field.

Since: 2.26

getUnixFdList

data DBusMessageGetUnixFdListMethodInfo Source #

Instances

((~) * signature (m UnixFDList), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageGetUnixFdListMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageGetUnixFdListMethodInfo a -> signature -> s #

dBusMessageGetUnixFdList Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m UnixFDList	Returns: A `UnixFDList` or `Nothing` if no file descriptors are associated. Do not free, this object is owned by `message`.

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

This method is only available on UNIX.

Since: 2.26

lock

data DBusMessageLockMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageLockMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageLockMethodInfo a -> signature -> s #

dBusMessageLock Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ()

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

Since: 2.26

new

dBusMessageNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new empty DBusMessage.

Since: 2.26

newFromBlob

dBusMessageNewFromBlob Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteString	`blob`: A blob represent a binary D-Bus message.
-> [DBusCapabilityFlags]	`capabilities`: A `DBusCapabilityFlags` describing what protocol features are supported.
-> m DBusMessage	Returns: A new `DBusMessage` or `Nothing` if `error` is set. Free with `objectUnref`. (Can throw `GError`)

Creates a new DBusMessage from the data stored at blob. The byte order that the message was in can be retrieved using dBusMessageGetByteOrder.

Since: 2.26

newMethodCall

dBusMessageNewMethodCall Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Maybe Text	`name`: A valid D-Bus name or `Nothing`.
-> Text	`path`: A valid object path.
-> Maybe Text	`interface_`: A valid D-Bus interface name or `Nothing`.
-> Text	`method`: A valid method name.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage for a method call.

Since: 2.26

newMethodErrorLiteral

data DBusMessageNewMethodErrorLiteralMethodInfo Source #

Instances

((~) * signature (Text -> Text -> m DBusMessage), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageNewMethodErrorLiteralMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageNewMethodErrorLiteralMethodInfo a -> signature -> s #

dBusMessageNewMethodErrorLiteral Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`methodCallMessage`: A message of type `DBusMessageTypeMethodCall` to create a reply message to.
-> Text	`errorName`: A valid D-Bus error name.
-> Text	`errorMessage`: The D-Bus error message.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage that is an error reply to methodCallMessage.

Since: 2.26

newMethodReply

data DBusMessageNewMethodReplyMethodInfo Source #

Instances

((~) * signature (m DBusMessage), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageNewMethodReplyMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageNewMethodReplyMethodInfo a -> signature -> s #

dBusMessageNewMethodReply Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`methodCallMessage`: A message of type `DBusMessageTypeMethodCall` to create a reply message to.
-> m DBusMessage	Returns: `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage that is a reply to methodCallMessage.

Since: 2.26

newSignal

dBusMessageNewSignal Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`path`: A valid object path.
-> Text	`interface_`: A valid D-Bus interface name.
-> Text	`signal`: A valid signal name.
-> m DBusMessage	Returns: A `DBusMessage`. Free with `objectUnref`.

Creates a new DBusMessage for a signal emission.

Since: 2.26

print

data DBusMessagePrintMethodInfo Source #

Instances

((~) * signature (Word32 -> m Text), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessagePrintMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessagePrintMethodInfo a -> signature -> s #

dBusMessagePrint Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`indent`: Indentation level.
-> m Text	Returns: A string that should be freed with `free`.

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

The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output looks something like this: > >Flags: none >Version: 0 >Serial: 4 >Headers: > path -> objectpath '/org/gtk/GDBus/TestObject' > interface -> 'org.gtk.GDBus.TestInterface' > member -> GimmeStdout > destination -> ':1.146' >Body: () >UNIX File Descriptors: > (none)

or > >Flags: no-reply-expected >Version: 0 >Serial: 477 >Headers: > reply-serial -> uint32 4 > destination -> ':1.159' > sender -> ':1.146' > num-unix-fds -> uint32 1 >Body: () >UNIX File Descriptors: > fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635

Since: 2.26

setBody

data DBusMessageSetBodyMethodInfo Source #

Instances

((~) * signature (GVariant -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetBodyMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetBodyMethodInfo a -> signature -> s #

dBusMessageSetBody Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> GVariant	`body`: Either `Nothing` or a `GVariant` that is a tuple.
-> m ()

Sets the body message. As a side-effect the DBusMessageHeaderFieldSignature header field is set to the type string of body (or cleared if body is Nothing).

If body is floating, message assumes ownership of body.

Since: 2.26

setByteOrder

data DBusMessageSetByteOrderMethodInfo Source #

Instances

((~) * signature (DBusMessageByteOrder -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetByteOrderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetByteOrderMethodInfo a -> signature -> s #

dBusMessageSetByteOrder Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageByteOrder	`byteOrder`: The byte order.
-> m ()

Sets the byte order of message.

setDestination

data DBusMessageSetDestinationMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetDestinationMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetDestinationMethodInfo a -> signature -> s #

dBusMessageSetDestination Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldDestination header field.

Since: 2.26

setErrorName

data DBusMessageSetErrorNameMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetErrorNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetErrorNameMethodInfo a -> signature -> s #

dBusMessageSetErrorName Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldErrorName header field.

Since: 2.26

setFlags

data DBusMessageSetFlagsMethodInfo Source #

Instances

((~) * signature ([DBusMessageFlags] -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetFlagsMethodInfo a -> signature -> s #

dBusMessageSetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> [DBusMessageFlags]	`flags`: Flags for `message` that are set (typically values from the `DBusMessageFlags` enumeration bitwise ORed together).
-> m ()

Sets the flags to set on message.

Since: 2.26

setHeader

data DBusMessageSetHeaderMethodInfo Source #

Instances

((~) * signature (DBusMessageHeaderField -> Maybe GVariant -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetHeaderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetHeaderMethodInfo a -> signature -> s #

dBusMessageSetHeader Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageHeaderField	`headerField`: A 8-bit unsigned integer (typically a value from the `DBusMessageHeaderField` enumeration)
-> Maybe GVariant	`value`: A `GVariant` to set the header field or `Nothing` to clear the header field.
-> m ()

Sets a header field on message.

If value is floating, message assumes ownership of value.

Since: 2.26

setInterface

data DBusMessageSetInterfaceMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetInterfaceMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetInterfaceMethodInfo a -> signature -> s #

dBusMessageSetInterface Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldInterface header field.

Since: 2.26

setMember

data DBusMessageSetMemberMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetMemberMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetMemberMethodInfo a -> signature -> s #

dBusMessageSetMember Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldMember header field.

Since: 2.26

setMessageType

data DBusMessageSetMessageTypeMethodInfo Source #

Instances

((~) * signature (DBusMessageType -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetMessageTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetMessageTypeMethodInfo a -> signature -> s #

dBusMessageSetMessageType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> DBusMessageType	`type`: A 8-bit unsigned integer (typically a value from the `DBusMessageType` enumeration).
-> m ()

Sets message to be of type.

Since: 2.26

setNumUnixFds

data DBusMessageSetNumUnixFdsMethodInfo Source #

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetNumUnixFdsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetNumUnixFdsMethodInfo a -> signature -> s #

dBusMessageSetNumUnixFds Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldNumUnixFds header field.

Since: 2.26

setPath

data DBusMessageSetPathMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetPathMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetPathMethodInfo a -> signature -> s #

dBusMessageSetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldPath header field.

Since: 2.26

setReplySerial

data DBusMessageSetReplySerialMethodInfo Source #

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetReplySerialMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetReplySerialMethodInfo a -> signature -> s #

dBusMessageSetReplySerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldReplySerial header field.

Since: 2.26

setSender

data DBusMessageSetSenderMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetSenderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetSenderMethodInfo a -> signature -> s #

dBusMessageSetSender Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldSender header field.

Since: 2.26

setSerial

data DBusMessageSetSerialMethodInfo Source #

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetSerialMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetSerialMethodInfo a -> signature -> s #

dBusMessageSetSerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Word32	`serial`: A `guint32`.
-> m ()

Sets the serial for message.

Since: 2.26

setSignature

data DBusMessageSetSignatureMethodInfo Source #

Instances

((~) * signature (Text -> m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageSetSignatureMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetSignatureMethodInfo a -> signature -> s #

dBusMessageSetSignature Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> Text	`value`: The value to set.
-> m ()

Convenience setter for the DBusMessageHeaderFieldSignature header field.

Since: 2.26

setUnixFdList

data DBusMessageSetUnixFdListMethodInfo Source #

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsDBusMessage a, IsUnixFDList b) => MethodInfo * DBusMessageSetUnixFdListMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageSetUnixFdListMethodInfo a -> signature -> s #

dBusMessageSetUnixFdList Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a, IsUnixFDList b)
=> a	`message`: A `DBusMessage`.
-> Maybe b	`fdList`: A `UnixFDList` or `Nothing`.
-> m ()

Sets the UNIX file descriptors associated with message. As a side-effect the DBusMessageHeaderFieldNumUnixFds header field is set to the number of fds in fdList (or cleared if fdList is Nothing).

This method is only available on UNIX.

Since: 2.26

toBlob

data DBusMessageToBlobMethodInfo Source #

Instances

((~) * signature ([DBusCapabilityFlags] -> m ByteString), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageToBlobMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageToBlobMethodInfo a -> signature -> s #

dBusMessageToBlob Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> [DBusCapabilityFlags]	`capabilities`: A `DBusCapabilityFlags` describing what protocol features are supported.
-> m ByteString	Returns: A pointer to a valid binary D-Bus message of `outSize` bytes generated by `message` or `Nothing` if `error` is set. Free with `free`. (Can throw `GError`)

Serializes message to a blob. The byte order returned by dBusMessageGetByteOrder will be used.

Since: 2.26

toGerror

data DBusMessageToGerrorMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsDBusMessage a) => MethodInfo * DBusMessageToGerrorMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy DBusMessageToGerrorMethodInfo a -> signature -> s #

dBusMessageToGerror Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusMessage a)
=> a	`message`: A `DBusMessage`.
-> m ()	(Can throw `GError`)

If message is not of type DBusMessageTypeError does nothing and returns False.

Otherwise this method encodes the error in message as a GError using g_dbus_error_set_dbus_error() using the information in the DBusMessageHeaderFieldErrorName header field of message as well as the first string item in message's body.

Since: 2.26

Properties

locked

data DBusMessageLockedPropertyInfo Source #

Instances

AttrInfo DBusMessageLockedPropertyInfo Source #
Associated Types type AttrAllowedOps DBusMessageLockedPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint DBusMessageLockedPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo :: * -> Constraint # type AttrGetType DBusMessageLockedPropertyInfo :: * # type AttrLabel DBusMessageLockedPropertyInfo :: Symbol # type AttrOrigin DBusMessageLockedPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o => Proxy * DBusMessageLockedPropertyInfo -> o -> IO (AttrGetType DBusMessageLockedPropertyInfo) # attrSet :: (AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o, AttrSetTypeConstraint DBusMessageLockedPropertyInfo b) => Proxy * DBusMessageLockedPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o => Proxy * DBusMessageLockedPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint DBusMessageLockedPropertyInfo o, AttrSetTypeConstraint DBusMessageLockedPropertyInfo b) => Proxy * DBusMessageLockedPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin DBusMessageLockedPropertyInfo Source #
type AttrOrigin DBusMessageLockedPropertyInfo = DBusMessage
type AttrLabel DBusMessageLockedPropertyInfo Source #
type AttrLabel DBusMessageLockedPropertyInfo = "locked"
type AttrGetType DBusMessageLockedPropertyInfo Source #
type AttrGetType DBusMessageLockedPropertyInfo = Bool
type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo Source #
type AttrBaseTypeConstraint DBusMessageLockedPropertyInfo = IsDBusMessage
type AttrSetTypeConstraint DBusMessageLockedPropertyInfo Source #
type AttrSetTypeConstraint DBusMessageLockedPropertyInfo = * ~ ()
type AttrAllowedOps DBusMessageLockedPropertyInfo Source #
type AttrAllowedOps DBusMessageLockedPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

dBusMessageLocked :: AttrLabelProxy "locked" Source #

getDBusMessageLocked :: (MonadIO m, IsDBusMessage o) => o -> m Bool Source #