DBus.Internal.Message

Documentation

class Message a where

Minimal complete definition

messageTypeCode, messageHeaderFields, messageBody

Methods

messageTypeCode :: a -> Word8

messageHeaderFields :: a -> [HeaderField]

messageBody :: a -> [Variant]

messageFlags :: a -> Word8

Instances

Message Signal

Methods

messageTypeCode :: Signal -> Word8

messageHeaderFields :: Signal -> [HeaderField]

messageBody :: Signal -> [Variant]

messageFlags :: Signal -> Word8

Message MethodError

Methods

messageTypeCode :: MethodError -> Word8

messageHeaderFields :: MethodError -> [HeaderField]

messageBody :: MethodError -> [Variant]

messageFlags :: MethodError -> Word8

Message MethodReturn

Methods

messageTypeCode :: MethodReturn -> Word8

messageHeaderFields :: MethodReturn -> [HeaderField]

messageBody :: MethodReturn -> [Variant]

messageFlags :: MethodReturn -> Word8

Message MethodCall

Methods

messageTypeCode :: MethodCall -> Word8

messageHeaderFields :: MethodCall -> [HeaderField]

messageBody :: MethodCall -> [Variant]

messageFlags :: MethodCall -> Word8

data UnknownMessage

Constructors

UnknownMessage

Fields

• unknownMessageType :: Word8
• unknownMessageSender :: Maybe BusName
• unknownMessageBody :: [Variant]

Instances

Eq UnknownMessage

Methods

(==) :: UnknownMessage -> UnknownMessage -> Bool

(/=) :: UnknownMessage -> UnknownMessage -> Bool

Show UnknownMessage

Methods

showsPrec :: Int -> UnknownMessage -> ShowS

show :: UnknownMessage -> String

showList :: [UnknownMessage] -> ShowS

data MethodCall

A method call is a request to run some procedure exported by the remote process. Procedures are identified by an (object_path, interface_name, method_name) tuple.

Constructors

MethodCall

Fields

• methodCallPath :: ObjectPath

  The object path of the method call. Conceptually, object paths act like a procedural language's pointers. Each object referenced by a path is a collection of procedures.

• methodCallInterface :: Maybe InterfaceName

  The interface of the method call. Each object may implement any number of interfaces. Each method is part of at least one interface.

  In certain cases, this may be Nothing, but most users should set it to a value.

• methodCallMember :: MemberName

  The method name of the method call. Method names are unique within an interface, but might not be unique within an object.

• methodCallSender :: Maybe BusName

  The name of the application that sent this call.

  Most users will just leave this empty, because the bus overwrites the sender for security reasons. Setting the sender manually is used for peer-peer connections.

  Defaults to Nothing.

• methodCallDestination :: Maybe BusName

  The name of the application to send the call to.

  Most users should set this. If a message with no destination is sent to the bus, the bus will behave as if the destination was set to org.freedesktop.DBus. For peer-peer connections, the destination can be empty because there is only one peer.

  Defaults to Nothing.

• methodCallReplyExpected :: Bool

  Set whether a reply is expected. This can save network and cpu resources by inhibiting unnecessary replies.

  Defaults to True.

• methodCallAutoStart :: Bool

  Set whether the bus should auto-start the remote

  Defaults to True.

• methodCallBody :: [Variant]

  The arguments to the method call. See toVariant.

  Defaults to [].

Instances

Eq MethodCall

Methods

(==) :: MethodCall -> MethodCall -> Bool

(/=) :: MethodCall -> MethodCall -> Bool

Show MethodCall

Methods

showsPrec :: Int -> MethodCall -> ShowS

show :: MethodCall -> String

showList :: [MethodCall] -> ShowS

Message MethodCall

Methods

messageTypeCode :: MethodCall -> Word8

messageHeaderFields :: MethodCall -> [HeaderField]

messageBody :: MethodCall -> [Variant]

messageFlags :: MethodCall -> Word8

data MethodReturn

A method return is a reply to a method call, indicating that the call succeeded.

Constructors

MethodReturn

Fields

• methodReturnSerial :: Serial

  The serial of the original method call. This lets the original caller match up this reply to the pending call.

• methodReturnSender :: Maybe BusName

  The name of the application that is returning from a call.

  Most users will just leave this empty, because the bus overwrites the sender for security reasons. Setting the sender manually is used for peer-peer connections.

  Defaults to Nothing.

• methodReturnDestination :: Maybe BusName

  The name of the application that initiated the call.

  Most users should set this. If a message with no destination is sent to the bus, the bus will behave as if the destination was set to org.freedesktop.DBus. For peer-peer connections, the destination can be empty because there is only one peer.

  Defaults to Nothing.

• methodReturnBody :: [Variant]

  Values returned from the method call. See toVariant.

  Defaults to [].

Instances

Eq MethodReturn

Methods

(==) :: MethodReturn -> MethodReturn -> Bool

(/=) :: MethodReturn -> MethodReturn -> Bool

Show MethodReturn

Methods

showsPrec :: Int -> MethodReturn -> ShowS

show :: MethodReturn -> String

showList :: [MethodReturn] -> ShowS

Message MethodReturn

Methods

messageTypeCode :: MethodReturn -> Word8

messageHeaderFields :: MethodReturn -> [HeaderField]

messageBody :: MethodReturn -> [Variant]

messageFlags :: MethodReturn -> Word8

data MethodError

A method error is a reply to a method call, indicating that the call received an error and did not succeed.

Constructors

MethodError

Fields

• methodErrorName :: ErrorName

  The name of the error type. Names are used so clients can handle certain classes of error differently from others.

• methodErrorSerial :: Serial

  The serial of the original method call. This lets the original caller match up this reply to the pending call.

• methodErrorSender :: Maybe BusName

  The name of the application that is returning from a call.

  Most users will just leave this empty, because the bus overwrites the sender for security reasons. Setting the sender manually is used for peer-peer connections.

  Defaults to Nothing.

• methodErrorDestination :: Maybe BusName

  The name of the application that initiated the call.

  Most users should set this. If a message with no destination is sent to the bus, the bus will behave as if the destination was set to org.freedesktop.DBus. For peer-peer connections, the destination can be empty because there is only one peer.

  Defaults to Nothing.

• methodErrorBody :: [Variant]

  Additional information about the error. By convention, if the error body contains any items, the first item should be a string describing the error.

Instances

Eq MethodError

Methods

(==) :: MethodError -> MethodError -> Bool

(/=) :: MethodError -> MethodError -> Bool

Show MethodError

Methods

showsPrec :: Int -> MethodError -> ShowS

show :: MethodError -> String

showList :: [MethodError] -> ShowS

Message MethodError

Methods

messageTypeCode :: MethodError -> Word8

messageHeaderFields :: MethodError -> [HeaderField]

messageBody :: MethodError -> [Variant]

messageFlags :: MethodError -> Word8

methodErrorMessage :: MethodError -> String

Get a human-readable description of the error, by returning the first item in the error body if it's a string.

data Signal

Signals are broadcast by applications to notify other clients of some event.

Constructors

Signal

Fields

• signalPath :: ObjectPath

  The path of the object that emitted this signal.

• signalInterface :: InterfaceName

  The interface that this signal belongs to.

• signalMember :: MemberName

  The name of this signal.

• signalSender :: Maybe BusName

  The name of the application that emitted this signal.

  Most users will just leave this empty, because the bus overwrites the sender for security reasons. Setting the sender manually is used for peer-peer connections.

  Defaults to Nothing.

• signalDestination :: Maybe BusName

  The name of the application to emit the signal to. If Nothing, the signal is sent to any application that has registered an appropriate match rule.

  Defaults to Nothing.

• signalBody :: [Variant]

  Additional information about the signal, such as the new value or the time.

  Defaults to [].

Instances

Eq Signal

Methods

(==) :: Signal -> Signal -> Bool

(/=) :: Signal -> Signal -> Bool

Show Signal

Methods

showsPrec :: Int -> Signal -> ShowS

show :: Signal -> String

showList :: [Signal] -> ShowS

Message Signal

Methods

messageTypeCode :: Signal -> Word8

messageHeaderFields :: Signal -> [HeaderField]

messageBody :: Signal -> [Variant]

messageFlags :: Signal -> Word8

data ReceivedMessage

Not an actual message type, but a wrapper around messages received from the bus. Each value contains the message's Serial.

If casing against these constructors, always include a default case to handle messages of an unknown type. New message types may be added to the D-Bus specification, and applications should handle them gracefully by either ignoring or logging them.

Constructors

ReceivedMethodCall Serial MethodCall

ReceivedMethodReturn Serial MethodReturn

ReceivedMethodError Serial MethodError

ReceivedSignal Serial Signal

ReceivedUnknown Serial UnknownMessage

Instances

Eq ReceivedMessage

Methods

(==) :: ReceivedMessage -> ReceivedMessage -> Bool

(/=) :: ReceivedMessage -> ReceivedMessage -> Bool

Show ReceivedMessage

Methods

showsPrec :: Int -> ReceivedMessage -> ShowS

show :: ReceivedMessage -> String

showList :: [ReceivedMessage] -> ShowS

data HeaderField

Constructors

HeaderPath ObjectPath

HeaderInterface InterfaceName

HeaderMember MemberName

HeaderErrorName ErrorName

HeaderReplySerial Serial

HeaderDestination BusName

HeaderSender BusName

HeaderSignature Signature

HeaderUnixFds Word32

Instances

Eq HeaderField

Methods

(==) :: HeaderField -> HeaderField -> Bool

(/=) :: HeaderField -> HeaderField -> Bool

Show HeaderField

Methods

showsPrec :: Int -> HeaderField -> ShowS

show :: HeaderField -> String

showList :: [HeaderField] -> ShowS

setMethodCallFlags :: MethodCall -> Word8 -> MethodCall