GI.Gio.Structs.DBusNodeInfo

Information about nodes in a remote object hierarchy.

Exported types

newtype DBusNodeInfo

Constructors

DBusNodeInfo (ManagedPtr DBusNodeInfo)

Instances

BoxedObject DBusNodeInfo

Methods

boxedType :: DBusNodeInfo -> IO GType

(~) AttrOpTag tag AttrSet => Constructible DBusNodeInfo tag

Methods

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

newZeroDBusNodeInfo :: MonadIO m => m DBusNodeInfo

Construct a DBusNodeInfo struct initialized to zero.

noDBusNodeInfo :: Maybe DBusNodeInfo

Methods

generateXml

dBusNodeInfoGenerateXml

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

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

lookupInterface

dBusNodeInfoLookupInterface

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo.

-> Text

name: A D-Bus interface name.

-> m DBusInterfaceInfo

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

Looks up information about an interface.

The cost of this function is O(n) in number of interfaces.

Since: 2.26

newForXml

dBusNodeInfoNewForXml

Arguments

:: (HasCallStack, MonadIO m)

=> Text

xmlData: Valid D-Bus introspection XML.

-> m DBusNodeInfo

Returns: A DBusNodeInfo structure or Nothing if error is set. Free with dBusNodeInfoUnref. (Can throw GError)

Parses xmlData and returns a DBusNodeInfo representing the data.

The introspection XML must contain exactly one top-level <node> element.

Note that this routine is using a [GMarkup][glib-Simple-XML-Subset-Parser.description]-based parser that only accepts a subset of valid XML documents.

Since: 2.26

ref

dBusNodeInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo

-> m DBusNodeInfo

Returns: The same info.

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

Since: 2.26

unref

dBusNodeInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DBusNodeInfo

info: A DBusNodeInfo.

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

clearDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m ()

getDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusAnnotationInfo])

setDBusNodeInfoAnnotations :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()

interfaces

clearDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m ()

getDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusInterfaceInfo])

setDBusNodeInfoInterfaces :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusInterfaceInfo) -> m ()

nodes

clearDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m ()

getDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> m (Maybe [DBusNodeInfo])

setDBusNodeInfoNodes :: MonadIO m => DBusNodeInfo -> Ptr (Ptr DBusNodeInfo) -> m ()

path

clearDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m ()

getDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> m (Maybe Text)

setDBusNodeInfoPath :: MonadIO m => DBusNodeInfo -> CString -> m ()

refCount

getDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> m Int32

setDBusNodeInfoRefCount :: MonadIO m => DBusNodeInfo -> Int32 -> m ()