GI.Gio.Structs.DBusInterfaceInfo

Information about a D-Bus interface.

Exported types

newtype DBusInterfaceInfo

Constructors

DBusInterfaceInfo (ManagedPtr DBusInterfaceInfo)

Instances

BoxedObject DBusInterfaceInfo

Methods

boxedType :: DBusInterfaceInfo -> IO GType

(~) AttrOpTag tag AttrSet => Constructible DBusInterfaceInfo tag

Methods

new :: MonadIO m => (ManagedPtr DBusInterfaceInfo -> DBusInterfaceInfo) -> [AttrOp DBusInterfaceInfo tag] -> m DBusInterfaceInfo

newZeroDBusInterfaceInfo :: MonadIO m => m DBusInterfaceInfo

Construct a DBusInterfaceInfo struct initialized to zero.

noDBusInterfaceInfo :: Maybe DBusInterfaceInfo

Methods

cacheBuild

dBusInterfaceInfoCacheBuild

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A 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

dBusInterfaceInfoCacheRelease

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A GDBusInterfaceInfo

-> 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

dBusInterfaceInfoGenerateXml

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A DBusNodeInfo

-> Word32

indent: Indentation level.

-> 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

dBusInterfaceInfoLookupMethod

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A DBusInterfaceInfo.

-> Text

name: A D-Bus method name (typically in CamelCase)

-> m DBusMethodInfo

Returns: A DBusMethodInfo or Nothing if not found. Do not free, it is owned by info.

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

dBusInterfaceInfoLookupProperty

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A DBusInterfaceInfo.

-> Text

name: A D-Bus property name (typically in CamelCase).

-> m DBusPropertyInfo

Returns: A DBusPropertyInfo or Nothing if not found. Do not free, it is owned by info.

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

dBusInterfaceInfoLookupSignal

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A DBusInterfaceInfo.

-> Text

name: A D-Bus signal name (typically in CamelCase)

-> m DBusSignalInfo

Returns: A DBusSignalInfo or Nothing if not found. Do not free, it is owned by info.

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

dBusInterfaceInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A DBusInterfaceInfo

-> m DBusInterfaceInfo

Returns: The same info.

If info is statically allocated does nothing. Otherwise increases the reference count.

Since: 2.26

unref

dBusInterfaceInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DBusInterfaceInfo

info: A 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 ()

getDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusAnnotationInfo])

setDBusInterfaceInfoAnnotations :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()

methods

clearDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m ()

getDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusMethodInfo])

setDBusInterfaceInfoMethods :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusMethodInfo) -> m ()

name

clearDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m ()

getDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> m (Maybe Text)

setDBusInterfaceInfoName :: MonadIO m => DBusInterfaceInfo -> CString -> m ()

properties

clearDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m ()

getDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusPropertyInfo])

setDBusInterfaceInfoProperties :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusPropertyInfo) -> m ()

refCount

getDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> m Int32

setDBusInterfaceInfoRefCount :: MonadIO m => DBusInterfaceInfo -> Int32 -> m ()

signals

clearDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m ()

getDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> m (Maybe [DBusSignalInfo])

setDBusInterfaceInfoSignals :: MonadIO m => DBusInterfaceInfo -> Ptr (Ptr DBusSignalInfo) -> m ()