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 |
Information about a D-Bus interface.
- newtype DBusInterfaceInfo = DBusInterfaceInfo (ManagedPtr DBusInterfaceInfo)
- newZeroDBusInterfaceInfo :: MonadIO m => m DBusInterfaceInfo
- noDBusInterfaceInfo :: Maybe DBusInterfaceInfo
- data DBusInterfaceInfoCacheBuildMethodInfo
- dBusInterfaceInfoCacheBuild :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> m ()
- data DBusInterfaceInfoCacheReleaseMethodInfo
- dBusInterfaceInfoCacheRelease :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> m ()
- data DBusInterfaceInfoGenerateXmlMethodInfo
- dBusInterfaceInfoGenerateXml :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> Word32 -> m String
- data DBusInterfaceInfoLookupMethodMethodInfo
- dBusInterfaceInfoLookupMethod :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> Text -> m DBusMethodInfo
- data DBusInterfaceInfoLookupPropertyMethodInfo
- dBusInterfaceInfoLookupProperty :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> Text -> m DBusPropertyInfo
- data DBusInterfaceInfoLookupSignalMethodInfo
- dBusInterfaceInfoLookupSignal :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> Text -> m DBusSignalInfo
- data DBusInterfaceInfoRefMethodInfo
- dBusInterfaceInfoRef :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> m DBusInterfaceInfo
- data DBusInterfaceInfoUnrefMethodInfo
- dBusInterfaceInfoUnref :: (HasCallStack, MonadIO m) => DBusInterfaceInfo -> m ()
- clearDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> m ()
- dBusInterfaceInfo_annotations :: AttrLabelProxy "annotations"
- getDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusAnnotationInfo])
- setDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()
- clearDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m ()
- dBusInterfaceInfo_methods :: AttrLabelProxy "methods"
- getDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusMethodInfo])
- setDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusMethodInfo) -> m ()
- clearDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m ()
- dBusInterfaceInfo_name :: AttrLabelProxy "name"
- getDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m (Maybe Text)
- setDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> CString -> m ()
- clearDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m ()
- dBusInterfaceInfo_properties :: AttrLabelProxy "properties"
- getDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusPropertyInfo])
- setDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusPropertyInfo) -> m ()
- dBusInterfaceInfo_refCount :: AttrLabelProxy "refCount"
- getDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> m Int32
- setDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> Int32 -> m ()
- clearDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m ()
- dBusInterfaceInfo_signals :: AttrLabelProxy "signals"
- getDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusSignalInfo])
- setDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusSignalInfo) -> m ()
Exported types
newtype DBusInterfaceInfo Source #
newZeroDBusInterfaceInfo :: MonadIO m => m DBusInterfaceInfo Source #
Construct a DBusInterfaceInfo
struct initialized to zero.
Methods
cacheBuild
data DBusInterfaceInfoCacheBuildMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DBusInterfaceInfoCacheBuildMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoCacheBuild Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> m () |
Builds a lookup-cache to speed up
dBusInterfaceInfoLookupMethod
,
dBusInterfaceInfoLookupSignal
and
dBusInterfaceInfoLookupProperty
.
If this has already been called with info
, the existing cache is
used and its use count is increased.
Note that info
cannot be modified until
dBusInterfaceInfoCacheRelease
is called.
Since: 2.30
cacheRelease
data DBusInterfaceInfoCacheReleaseMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DBusInterfaceInfoCacheReleaseMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoCacheRelease Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> m () |
Decrements the usage count for the cache for info
built by
dBusInterfaceInfoCacheBuild
(if any) and frees the
resources used by the cache if the usage count drops to zero.
Since: 2.30
generateXml
data DBusInterfaceInfoGenerateXmlMethodInfo Source #
((~) * signature (Word32 -> m String), MonadIO m) => MethodInfo * DBusInterfaceInfoGenerateXmlMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoGenerateXml Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> Word32 |
|
-> m String |
Appends an XML representation of info
(and its children) to stringBuilder
.
This function is typically used for generating introspection XML
documents at run-time for handling the
org.freedesktop.DBus.Introspectable.Introspect
method.
Since: 2.26
lookupMethod
data DBusInterfaceInfoLookupMethodMethodInfo Source #
((~) * signature (Text -> m DBusMethodInfo), MonadIO m) => MethodInfo * DBusInterfaceInfoLookupMethodMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoLookupMethod Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> Text |
|
-> m DBusMethodInfo | Returns: A |
Looks up information about a method.
The cost of this function is O(n) in number of methods unless
dBusInterfaceInfoCacheBuild
has been used on info
.
Since: 2.26
lookupProperty
data DBusInterfaceInfoLookupPropertyMethodInfo Source #
((~) * signature (Text -> m DBusPropertyInfo), MonadIO m) => MethodInfo * DBusInterfaceInfoLookupPropertyMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoLookupProperty Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> Text |
|
-> m DBusPropertyInfo | Returns: A |
Looks up information about a property.
The cost of this function is O(n) in number of properties unless
dBusInterfaceInfoCacheBuild
has been used on info
.
Since: 2.26
lookupSignal
data DBusInterfaceInfoLookupSignalMethodInfo Source #
((~) * signature (Text -> m DBusSignalInfo), MonadIO m) => MethodInfo * DBusInterfaceInfoLookupSignalMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoLookupSignal Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> Text |
|
-> m DBusSignalInfo | Returns: A |
Looks up information about a signal.
The cost of this function is O(n) in number of signals unless
dBusInterfaceInfoCacheBuild
has been used on info
.
Since: 2.26
ref
data DBusInterfaceInfoRefMethodInfo Source #
((~) * signature (m DBusInterfaceInfo), MonadIO m) => MethodInfo * DBusInterfaceInfoRefMethodInfo DBusInterfaceInfo signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> m DBusInterfaceInfo | Returns: The same |
If info
is statically allocated does nothing. Otherwise increases
the reference count.
Since: 2.26
unref
data DBusInterfaceInfoUnrefMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DBusInterfaceInfoUnrefMethodInfo DBusInterfaceInfo signature Source # | |
dBusInterfaceInfoUnref Source #
:: (HasCallStack, MonadIO m) | |
=> DBusInterfaceInfo |
|
-> m () |
If info
is statically allocated, does nothing. Otherwise decreases
the reference count of info
. When its reference count drops to 0,
the memory used is freed.
Since: 2.26
Properties
annotations
clearDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> m () Source #
dBusInterfaceInfo_annotations :: AttrLabelProxy "annotations" Source #
getDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusAnnotationInfo]) Source #
setDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusAnnotationInfo) -> m () Source #
methods
clearDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m () Source #
dBusInterfaceInfo_methods :: AttrLabelProxy "methods" Source #
getDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusMethodInfo]) Source #
setDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusMethodInfo) -> m () Source #
name
clearDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m () Source #
dBusInterfaceInfo_name :: AttrLabelProxy "name" Source #
getDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m (Maybe Text) Source #
setDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> CString -> m () Source #
properties
clearDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m () Source #
dBusInterfaceInfo_properties :: AttrLabelProxy "properties" Source #
getDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusPropertyInfo]) Source #
setDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusPropertyInfo) -> m () Source #
refCount
dBusInterfaceInfo_refCount :: AttrLabelProxy "refCount" Source #
getDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> m Int32 Source #
setDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> Int32 -> m () Source #
signals
clearDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m () Source #
dBusInterfaceInfo_signals :: AttrLabelProxy "signals" Source #
getDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusSignalInfo]) Source #
setDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusSignalInfo) -> m () Source #