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 |
Virtual table for handling properties and method calls for a D-Bus interface.
Since 2.38, if you want to handle getting/setting D-Bus properties
asynchronously, give Nothing
as your get_property()
or set_property()
function. The D-Bus call will be directed to your methodCall
function,
with the provided interfaceName
set to "org.freedesktop.DBus.Properties".
Ownership of the DBusMethodInvocation
object passed to the
method_call()
function is transferred to your handler; you must
call one of the methods of DBusMethodInvocation
to return a reply
(possibly empty), or an error. These functions also take ownership
of the passed-in invocation object, so unless the invocation
object has otherwise been referenced, it will be then be freed.
Calling one of these functions may be done within your
method_call()
implementation but it also can be done at a later
point to handle the method asynchronously.
The usual checks on the validity of the calls is performed. For
Get
calls, an error is automatically returned if the property does
not exist or the permissions do not allow access. The same checks are
performed for Set
calls, and the provided value is also checked for
being the correct type.
For both Get
and Set
calls, the DBusMethodInvocation
passed to the methodCall
handler can be queried with
dBusMethodInvocationGetPropertyInfo
to get a pointer
to the DBusPropertyInfo
of the property.
If you have readable properties specified in your interface info,
you must ensure that you either provide a non-Nothing
getProperty
()
function or provide implementations of both the Get
and GetAll
methods on org.freedesktop.DBus.Properties interface in your methodCall
function. Note that the required return type of the Get
call is
(v)
, not the type of the property. GetAll
expects a return value
of type a{sv}
.
If you have writable properties specified in your interface info,
you must ensure that you either provide a non-Nothing
setProperty
()
function or provide an implementation of the Set
call. If implementing
the call, you must return the value of type G_VARIANT_TYPE_UNIT
.
- newtype DBusInterfaceVTable = DBusInterfaceVTable (ManagedPtr DBusInterfaceVTable)
- newZeroDBusInterfaceVTable :: MonadIO m => m DBusInterfaceVTable
- noDBusInterfaceVTable :: Maybe DBusInterfaceVTable
- clearDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> m ()
- dBusInterfaceVTable_getProperty :: AttrLabelProxy "getProperty"
- getDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> m (Maybe DBusInterfaceGetPropertyFunc_WithClosures)
- setDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> FunPtr C_DBusInterfaceGetPropertyFunc -> m ()
- clearDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> m ()
- dBusInterfaceVTable_methodCall :: AttrLabelProxy "methodCall"
- getDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> m (Maybe DBusInterfaceMethodCallFunc_WithClosures)
- setDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> FunPtr C_DBusInterfaceMethodCallFunc -> m ()
- clearDBusInterfaceVTableSetProperty :: MonadIO m => DBusInterfaceVTable -> m ()
- dBusInterfaceVTable_setProperty :: AttrLabelProxy "setProperty"
- getDBusInterfaceVTableSetProperty :: MonadIO m => DBusInterfaceVTable -> m (Maybe DBusInterfaceSetPropertyFunc_WithClosures)
- setDBusInterfaceVTableSetProperty :: MonadIO m => DBusInterfaceVTable -> FunPtr C_DBusInterfaceSetPropertyFunc -> m ()
Exported types
newtype DBusInterfaceVTable Source #
WrappedPtr DBusInterfaceVTable Source # | |
(~) AttrOpTag tag AttrSet => Constructible DBusInterfaceVTable tag Source # | |
((~) * info (ResolveDBusInterfaceVTableMethod t DBusInterfaceVTable), MethodInfo * info DBusInterfaceVTable p) => IsLabel t (DBusInterfaceVTable -> p) Source # | |
((~) * info (ResolveDBusInterfaceVTableMethod t DBusInterfaceVTable), MethodInfo * info DBusInterfaceVTable p) => IsLabelProxy t (DBusInterfaceVTable -> p) Source # | |
HasAttributeList * DBusInterfaceVTable Source # | |
type AttributeList DBusInterfaceVTable Source # | |
newZeroDBusInterfaceVTable :: MonadIO m => m DBusInterfaceVTable Source #
Construct a DBusInterfaceVTable
struct initialized to zero.
Properties
getProperty
clearDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> m () Source #
dBusInterfaceVTable_getProperty :: AttrLabelProxy "getProperty" Source #
getDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> m (Maybe DBusInterfaceGetPropertyFunc_WithClosures) Source #
setDBusInterfaceVTableGetProperty :: MonadIO m => DBusInterfaceVTable -> FunPtr C_DBusInterfaceGetPropertyFunc -> m () Source #
methodCall
clearDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> m () Source #
dBusInterfaceVTable_methodCall :: AttrLabelProxy "methodCall" Source #
getDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> m (Maybe DBusInterfaceMethodCallFunc_WithClosures) Source #
setDBusInterfaceVTableMethodCall :: MonadIO m => DBusInterfaceVTable -> FunPtr C_DBusInterfaceMethodCallFunc -> m () Source #
setProperty
clearDBusInterfaceVTableSetProperty :: MonadIO m => DBusInterfaceVTable -> m () Source #
dBusInterfaceVTable_setProperty :: AttrLabelProxy "setProperty" Source #