DBus

Connection management

data ConnectionType

Which Bus to connect to

Constructors

Session

The well-known system bus. First the environmental variable DBUS_SESSION_BUS_ADDRESS is checked and if it doesn't exist the address unix:path=\var/run/dbus/system_bus_socket/ is used

System

The well-known system bus. Refers to the address stored in the environmental variable DBUS_SESSION_BUS_ADDRESS

Address String

The bus at the give addresss

connectBus

Arguments

:: ConnectionType

Bus to connect to

-> MethodCallHandler

Handler for incoming method calls

-> SignalHandler

Handler for incoming signals

-> IO DBusConnection

Create a new connection to a message bus

type MethodCallHandler = DBusConnection -> MessageHeader -> [SomeDBusValue] -> IO ()

type SignalHandler = DBusConnection -> MessageHeader -> [SomeDBusValue] -> IO ()

checkAlive :: DBusConnection -> IO Bool

Check whether connection is alive

waitFor :: DBusConnection -> IO ()

Wait until connection is closed

Message handling

objectRoot :: Object -> Handler

Create a message handler that dispatches matches to the methods in a root object

Signals

data MatchRule

Constructors

MatchRule

Fields

mrType :: Maybe MessageType

mrSender :: Maybe Text

mrInterface :: Maybe Text

mrMember :: Maybe Text

mrPath :: Maybe (Bool, ObjectPath)

mrDestination :: Maybe Text

mrArgs :: [(Int, Text)]

mrArgPaths :: [(Int, Text)]

mrArg0namespace :: Maybe Text

mrEavesdrop :: Maybe Bool

matchAll :: MatchRule

matchSignal :: MessageHeader -> MatchRule -> Bool

Match a Signal against a rule. The argN, argNPath and arg0namespace parameter are ignored at the moment

addMatch :: (MonadIO m, MonadThrow m) => MatchRule -> DBusConnection -> m ()

removeMatch :: (MonadIO m, MonadThrow m) => MatchRule -> DBusConnection -> m ()

Representable Types

class Representable a where

Associated Types

type RepType a :: DBusType

Methods

toRep :: a -> DBusValue (RepType a)

fromRep :: DBusValue (RepType a) -> Maybe a

Instances

Representable Bool

Representable Double

Representable Int16

Representable Int32

Representable Int64

Representable Word8

Representable Word16

Representable Word32

Representable Word64

Representable ()

Representable ByteString

Representable Text

Representable Signature

Representable ObjectPath

Representable Endian

Representable HeaderField

Representable HeaderFields

Representable Flags

Representable MessageType

Representable MessageHeader

(Representable a, SingI DBusType (RepType a)) => Representable [a]

(Representable l, Representable r, SingI DBusType (RepType l), SingI DBusType (RepType r)) => Representable (Either l r)

(Representable a, Representable b) => Representable (a, b)

(Ord k, Representable k, ~ DBusType (RepType k) (DBusSimpleType r), Representable v) => Representable (Map k v)

(Representable a, Representable b, Representable c) => Representable (a, b, c)

(Representable a, Representable b, Representable c, Representable d) => Representable (a, b, c, d)

(Representable a, Representable b, Representable c, Representable d, Representable e) => Representable (a, b, c, d, e)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f) => Representable (a, b, c, d, e, f)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g) => Representable (a, b, c, d, e, f, g)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h) => Representable (a, b, c, d, e, f, g, h)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i) => Representable (a, b, c, d, e, f, g, h, i)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j) => Representable (a, b, c, d, e, f, g, h, i, j)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k) => Representable (a, b, c, d, e, f, g, h, i, j, k)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l) => Representable (a, b, c, d, e, f, g, h, i, j, k, l)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o, Representable p) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o, Representable p, Representable q) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o, Representable p, Representable q, Representable r) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o, Representable p, Representable q, Representable r, Representable s) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s)

(Representable a, Representable b, Representable c, Representable d, Representable e, Representable f, Representable g, Representable h, Representable i, Representable j, Representable k, Representable l, Representable m, Representable n, Representable o, Representable p, Representable q, Representable r, Representable s, Representable t) => Representable (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t)

makeRepresentable :: Name -> Q [Dec]

makeRepresentableTuple :: Int -> Q Dec

DBus specific types

DBus Values

data DBusValue where

Constructors

DBVByte :: Word8 -> DBusValue (DBusSimpleType TypeByte)

DBVBool :: Bool -> DBusValue (DBusSimpleType TypeBoolean)

DBVInt16 :: Int16 -> DBusValue (DBusSimpleType TypeInt16)

DBVUInt16 :: Word16 -> DBusValue (DBusSimpleType TypeUInt16)

DBVInt32 :: Int32 -> DBusValue (DBusSimpleType TypeInt32)

DBVUInt32 :: Word32 -> DBusValue (DBusSimpleType TypeUInt32)

DBVInt64 :: Int64 -> DBusValue (DBusSimpleType TypeInt64)

DBVUInt64 :: Word64 -> DBusValue (DBusSimpleType TypeUInt64)

DBVDouble :: Double -> DBusValue (DBusSimpleType TypeDouble)

DBVUnixFD :: Word32 -> DBusValue (DBusSimpleType TypeUnixFD)

DBVString :: Text -> DBusValue (DBusSimpleType TypeString)

DBVObjectPath :: ObjectPath -> DBusValue (DBusSimpleType TypeObjectPath)

DBVSignature :: [DBusType] -> DBusValue (DBusSimpleType TypeSignature)

DBVVariant :: SingI t => DBusValue t -> DBusValue TypeVariant

DBVArray :: [DBusValue a] -> DBusValue (TypeArray a)

DBVByteArray :: ByteString -> DBusValue (TypeArray (DBusSimpleType TypeByte))

DBVStruct :: DBusStruct ts -> DBusValue (TypeStruct ts)

DBVDict :: [(DBusValue (DBusSimpleType k), DBusValue v)] -> DBusValue (TypeDict k v)

DBVUnit :: DBusValue TypeUnit

Instances

Eq (DBusValue t)

SingI DBusType t => Show (DBusValue t)

SingI DBusType t => IsMethod (IO (DBusValue t))

(IsMethod f, SingI DBusType t) => IsMethod (DBusValue t -> f)

castDBV :: (SingI s, SingI t) => DBusValue s -> Maybe (DBusValue t)

data DBusStruct where

Constructors

StructSingleton :: DBusValue a -> DBusStruct `[a]`

StructCons :: DBusValue a -> DBusStruct as -> DBusStruct (a : as)

Instances

Eq (DBusStruct t)

SingI [DBusType] a => Show (DBusStruct a)

data SomeDBusValue where

Constructors

DBV :: SingI t => DBusValue t -> SomeDBusValue

Instances

Show SomeDBusValue

dbusValue :: SingI t => SomeDBusValue -> Maybe (DBusValue t)

fromVariant :: SingI t => DBusValue TypeVariant -> Maybe (DBusValue t)

Extract a DBusValue from a Variant iff the type matches or return nothing

Signature

data DBusSimpleType

Constructors

TypeByte

TypeBoolean

TypeInt16

TypeUInt16

TypeInt32

TypeUInt32

TypeInt64

TypeUInt64

TypeDouble

TypeUnixFD

TypeString

TypeObjectPath

TypeSignature

Instances

Eq DBusSimpleType

Data DBusSimpleType

Read DBusSimpleType

Show DBusSimpleType

Typeable DBusSimpleType

SingI DBusSimpleType TypeSignature

SingI DBusSimpleType TypeObjectPath

SingI DBusSimpleType TypeString

SingI DBusSimpleType TypeUnixFD

SingI DBusSimpleType TypeDouble

SingI DBusSimpleType TypeUInt64

SingI DBusSimpleType TypeInt64

SingI DBusSimpleType TypeUInt32

SingI DBusSimpleType TypeInt32

SingI DBusSimpleType TypeUInt16

SingI DBusSimpleType TypeInt16

SingI DBusSimpleType TypeBoolean

SingI DBusSimpleType TypeByte

SingKind DBusSimpleType (KProxy DBusSimpleType)

SEq DBusSimpleType (KProxy DBusSimpleType)

data DBusType

Constructors

DBusSimpleType DBusSimpleType

TypeArray DBusType

TypeStruct [DBusType]

TypeDict DBusSimpleType DBusType

TypeVariant

TypeDictEntry DBusSimpleType DBusType

TypeUnit

Instances

Eq DBusType

Data DBusType

Read DBusType

Show DBusType

Typeable DBusType

SingI DBusType TypeUnit

SingI DBusType TypeVariant

SingKind DBusType (KProxy DBusType)

SingI [DBusType] n0 => SingI DBusType (TypeStruct n0)

SingI DBusType n0 => SingI DBusType (TypeArray n0)

SingI DBusSimpleType n0 => SingI DBusType (DBusSimpleType n0)

SEq DBusType (KProxy DBusType)

(SingI DBusSimpleType n0, SingI DBusType n1) => SingI DBusType (TypeDictEntry n0 n1)

(SingI DBusSimpleType n0, SingI DBusType n1) => SingI DBusType (TypeDict n0 n1)

newtype Signature

Constructors

Signature

Fields

fromSignature :: [DBusType]

Instances

Eq Signature

Show Signature

Representable Signature

typeOf :: SingI t => DBusValue t -> DBusType

ObjectPath

data ObjectPath

Instances

Eq ObjectPath

Data ObjectPath

Show ObjectPath

Typeable ObjectPath

Representable ObjectPath

objectPath :: Text -> ObjectPath

Parse an object path. Contrary to the standard, empty path parts are ignored

objectPathToText :: ObjectPath -> Text

stripObjectPrefix :: ObjectPath -> ObjectPath -> Maybe ObjectPath

isPathPrefix :: ObjectPath -> ObjectPath -> Bool

isRoot :: ObjectPath -> Bool

isEmpty :: ObjectPath -> Bool

Methods

data Method where

Constructors

Method :: (SingI avs, SingI t) => MethodWrapper avs t -> Text -> MethodDescription (ArgParity avs) -> Method

Instances

Show Method

data MethodWrapper av rv where

Constructors

MReturn :: SingI t => IO (DBusValue t) -> MethodWrapper `[]` t

MAsk :: SingI t => (DBusValue t -> MethodWrapper avs rv) -> MethodWrapper (t : avs) rv

repMethod :: RepMethod f => f -> MethodWrapper (RepMethodArgs f) (RepMethodValue f)

callMethod

Arguments

:: Text

Entity to send the message to

-> ObjectPath

Object

-> Text

Interface

-> Text

Member (method) name

-> [SomeDBusValue]

Arguments

-> [Flag]

Method call flags

-> DBusConnection

Connection to send the call over

-> IO (STM (Either [SomeDBusValue] SomeDBusValue))

Asychronously call a method. Returns an STM action that waits for the returned value.

callMethod'

Arguments

:: (SingI (RepType a), Representable a, MonadThrow m, MonadIO m)

=> Text

Entity to send the message to

-> ObjectPath

Object

-> Text

Interface

-> Text

Member (method) to call

-> [SomeDBusValue]

Arguments

-> [Flag]

Method call flags

-> DBusConnection

Connection to send the call over

-> m a

Synchronously call a method. Returned errors are thrown as MethodErrors. If the returned value's type doesn't match the expected type a MethodSignatureMissmatch is thrown.

Introspection

addIntrospectable :: Object -> Object

Message Bus

requestName :: (MonadIO m, MonadThrow m) => Text -> RequestNameFlag -> DBusConnection -> m RequestNameReply

data RequestNameFlag

Constructors

RequestNameFlag

Fields

allowReplacement :: Bool

replaceExisting :: Bool

doNotQueue :: Bool

Instances

Default RequestNameFlag

data RequestNameReply

Constructors

PrimaryOwner

InQueue

Exists

AlreadyOwner

releaseName :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m ReleaseNameReply

data ReleaseNameReply

Constructors

Released

NonExistent

NotOwner

listQueuedOwners :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m [Text]

listNames :: (MonadIO m, MonadThrow m) => DBusConnection -> m [Text]

listActivatableNames :: (MonadIO m, MonadThrow m) => DBusConnection -> m [Text]

nameHasOwner :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m Bool

startServiceByName :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m StartServiceResult

getNameOwner :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m Text

getConnectionUnixUser :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m Word32

getConnectionProcessID :: (MonadIO m, MonadThrow m) => Text -> DBusConnection -> m Word32

getID :: (MonadIO m, MonadThrow m) => DBusConnection -> m Text