DBus.TH.EDSL

Documentation

module Data.Int

module Data.Word

data Client :: *

An active client session to a message bus. Clients may send or receive method calls, and listen for or emit signals.

Instances

IsValue a => AutoMethod (DBusR (Either Reply a))

Methods

funTypes :: DBusR (Either Reply a) -> ([Type], [Type])

apply :: DBusR (Either Reply a) -> [Variant] -> DBusR Reply

IsValue a => AutoMethod (DBusR a)

Methods

funTypes :: DBusR a -> ([Type], [Type])

apply :: DBusR a -> [Variant] -> DBusR Reply

data BusName :: *

Bus names are used to identify particular clients on the message bus. A bus name may be either unique or well-known, where unique names start with a colon. Bus names consist of alphanumeric characters separated by periods.

See http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus for details.

Instances

Eq BusName

Methods

(==) :: BusName -> BusName -> Bool

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

Ord BusName

Methods

compare :: BusName -> BusName -> Ordering

(<) :: BusName -> BusName -> Bool

(<=) :: BusName -> BusName -> Bool

(>) :: BusName -> BusName -> Bool

(>=) :: BusName -> BusName -> Bool

max :: BusName -> BusName -> BusName

min :: BusName -> BusName -> BusName

Show BusName

Methods

showsPrec :: Int -> BusName -> ShowS

show :: BusName -> String

showList :: [BusName] -> ShowS

IsString BusName

Methods

fromString :: String -> BusName

Lift BusName

Methods

lift :: BusName -> Q Exp

IsVariant BusName

Methods

toVariant :: BusName -> Variant

fromVariant :: Variant -> Maybe BusName

NFData BusName

Methods

rnf :: BusName -> ()

data ObjectPath :: *

Object paths are special strings, used to identify a particular object exported from a D-Bus application.

Object paths must begin with a slash, and consist of alphanumeric characters separated by slashes.

See http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-marshaling-object-path for details.

Instances

Eq ObjectPath

Methods

(==) :: ObjectPath -> ObjectPath -> Bool

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

Ord ObjectPath

Methods

compare :: ObjectPath -> ObjectPath -> Ordering

(<) :: ObjectPath -> ObjectPath -> Bool

(<=) :: ObjectPath -> ObjectPath -> Bool

(>) :: ObjectPath -> ObjectPath -> Bool

(>=) :: ObjectPath -> ObjectPath -> Bool

max :: ObjectPath -> ObjectPath -> ObjectPath

min :: ObjectPath -> ObjectPath -> ObjectPath

Show ObjectPath

Methods

showsPrec :: Int -> ObjectPath -> ShowS

show :: ObjectPath -> String

showList :: [ObjectPath] -> ShowS

IsString ObjectPath

Methods

fromString :: String -> ObjectPath

Lift ObjectPath

Methods

lift :: ObjectPath -> Q Exp

IsVariant ObjectPath

Methods

toVariant :: ObjectPath -> Variant

fromVariant :: Variant -> Maybe ObjectPath

IsValue ObjectPath

Methods

typeOf :: ObjectPath -> Type

toValue :: ObjectPath -> Value

fromValue :: Value -> Maybe ObjectPath

IsAtom ObjectPath

Methods

toAtom :: ObjectPath -> Atom

fromAtom :: Atom -> Maybe ObjectPath

NFData ObjectPath

Methods

rnf :: ObjectPath -> ()

data InterfaceName :: *

Interfaces are used to group a set of methods and signals within an exported object. Interface names consist of alphanumeric characters separated by periods.

See http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface for details.

Instances

Eq InterfaceName

Methods

(==) :: InterfaceName -> InterfaceName -> Bool

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

Ord InterfaceName

Methods

compare :: InterfaceName -> InterfaceName -> Ordering

(<) :: InterfaceName -> InterfaceName -> Bool

(<=) :: InterfaceName -> InterfaceName -> Bool

(>) :: InterfaceName -> InterfaceName -> Bool

(>=) :: InterfaceName -> InterfaceName -> Bool

max :: InterfaceName -> InterfaceName -> InterfaceName

min :: InterfaceName -> InterfaceName -> InterfaceName

Show InterfaceName

Methods

showsPrec :: Int -> InterfaceName -> ShowS

show :: InterfaceName -> String

showList :: [InterfaceName] -> ShowS

IsString InterfaceName

Methods

fromString :: String -> InterfaceName

Lift InterfaceName

Methods

lift :: InterfaceName -> Q Exp

IsVariant InterfaceName

Methods

toVariant :: InterfaceName -> Variant

fromVariant :: Variant -> Maybe InterfaceName

NFData InterfaceName

Methods

rnf :: InterfaceName -> ()

data MemberName :: *

Member names are used to identify a single method or signal within an interface. Method names consist of alphanumeric characters.

See http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-member for details.

Instances

Eq MemberName

Methods

(==) :: MemberName -> MemberName -> Bool

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

Ord MemberName

Methods

compare :: MemberName -> MemberName -> Ordering

(<) :: MemberName -> MemberName -> Bool

(<=) :: MemberName -> MemberName -> Bool

(>) :: MemberName -> MemberName -> Bool

(>=) :: MemberName -> MemberName -> Bool

max :: MemberName -> MemberName -> MemberName

min :: MemberName -> MemberName -> MemberName

Show MemberName

Methods

showsPrec :: Int -> MemberName -> ShowS

show :: MemberName -> String

showList :: [MemberName] -> ShowS

IsString MemberName

Methods

fromString :: String -> MemberName

Lift MemberName

Methods

lift :: MemberName -> Q Exp

IsVariant MemberName

Methods

toVariant :: MemberName -> Variant

fromVariant :: Variant -> Maybe MemberName

NFData MemberName

Methods

rnf :: MemberName -> ()

data Variant :: *

Variants may contain any other built-in D-Bus value. Besides representing native VARIANT values, they allow type-safe storage and inspection of D-Bus collections.

Instances

Eq Variant

Methods

(==) :: Variant -> Variant -> Bool

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

Show Variant

Methods

showsPrec :: Int -> Variant -> ShowS

show :: Variant -> String

showList :: [Variant] -> ShowS

IsVariant Variant

Methods

toVariant :: Variant -> Variant

fromVariant :: Variant -> Maybe Variant

IsValue Variant

Methods

typeOf :: Variant -> Type

toValue :: Variant -> Value

fromValue :: Value -> Maybe Variant

connectSession :: IO Client

Connect to the bus specified in the environment variable DBUS_SESSION_BUS_ADDRESS, which must be set.

Throws a ClientError if DBUS_SESSION_BUS_ADDRESS is unset, contains an invalid address, or if connecting to the bus failed.

connectSystem :: IO Client

Connect to the bus specified in the environment variable DBUS_SYSTEM_BUS_ADDRESS, or to unix:path=/var/run/dbus/system_bus_socket if DBUS_SYSTEM_BUS_ADDRESS is not set.

Throws a ClientError if DBUS_SYSTEM_BUS_ADDRESS contains an invalid address, or if connecting to the bus failed.

data Signature

Function signature

Constructors

Return Name

Name :-> Signature infixr 6

Instances

Eq Signature

Methods

(==) :: Signature -> Signature -> Bool

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

Data Signature

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Signature -> c Signature

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Signature

toConstr :: Signature -> Constr

dataTypeOf :: Signature -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Signature)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Signature)

gmapT :: (forall b. Data b => b -> b) -> Signature -> Signature

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Signature -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Signature -> r

gmapQ :: (forall d. Data d => d -> u) -> Signature -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Signature -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Signature -> m Signature

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Signature -> m Signature

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Signature -> m Signature

Show Signature

Methods

showsPrec :: Int -> Signature -> ShowS

show :: Signature -> String

showList :: [Signature] -> ShowS

signatureResult :: Signature -> Name

Return type name for signature

data Function

Function with DBus name and Haskell name

Constructors

Function

Fields

• fnName :: String

  Function name to use in Haskell

• fnDBusName :: String

  Function name to use in DBus

• fnSignature :: Signature

  Function signature

Instances

Eq Function

Methods

(==) :: Function -> Function -> Bool

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

Data Function

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Function -> c Function

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Function

toConstr :: Function -> Constr

dataTypeOf :: Function -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Function)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Function)

gmapT :: (forall b. Data b => b -> b) -> Function -> Function

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Function -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Function -> r

gmapQ :: (forall d. Data d => d -> u) -> Function -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Function -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Function -> m Function

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Function -> m Function

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Function -> m Function

Show Function

Methods

showsPrec :: Int -> Function -> ShowS

show :: Function -> String

showList :: [Function] -> ShowS

(=::) :: String -> Signature -> Function infixr 5

Create a Function from it's name and Signature. Sets fnDBusName == fnName.

as :: Function -> String -> Function infixl 4

Set specific Haskell name for Function.

function

Arguments

:: String

Bus name

-> String

Object name

-> String

Interface name

-> Maybe String

Prefix

-> Function

Function

-> Q [Dec]

Generate binding for one method in specific DBus interface. If second argument is (Just prefix), then prefix will be added to the beginning of all DBus names and removed from all Haskell names.

interface

Arguments

:: String

Bus name

-> String

Object name

-> String

Interface name

-> Maybe String

Prefix

-> [Function]

List of functions

-> Q [Dec]

Generate bindings for methods in specific DBus interface. If second argument is (Just prefix), then prefix will be added to the beginning of all DBus names and removed from all Haskell names.

function'

Arguments

:: String

Bus name

-> Maybe String

Just name - use fixed object name; Nothing - object name will be 2nd argument of generated function

-> String

Interface name

-> Maybe String

Prefix

-> Function

Function

-> Q [Dec]

Generate binding for one method in specific DBus interface. If second argument is (Just prefix), then prefix will be added to the beginning of all DBus names and removed from all Haskell names.

interface'

Arguments

:: String

Bus name

-> Maybe String

Just name - use fixed object name; Nothing - object name will be 2nd argument of generated functions

-> String

Interface name

-> Maybe String

Prefix

-> [Function]

List of functions

-> Q [Dec]

Generate bindings for methods in specific DBus interface. If second argument is (Just prefix), then prefix will be added to the beginning of all DBus names and removed from all Haskell names.