GI.Gio.Structs.DBusMethodInfo

Information about a method on an D-Bus interface.

Since: 2.26

Exported types

newtype DBusMethodInfo

Memory-managed wrapper type.

Constructors

DBusMethodInfo (ManagedPtr DBusMethodInfo)

Instances

Eq DBusMethodInfo

Defined in GI.Gio.Structs.DBusMethodInfo

Methods

(==) :: DBusMethodInfo -> DBusMethodInfo -> Bool

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

BoxedObject DBusMethodInfo

Defined in GI.Gio.Structs.DBusMethodInfo

Methods

boxedType :: DBusMethodInfo -> IO GType

IsGValue DBusMethodInfo

Convert DBusMethodInfo to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Structs.DBusMethodInfo

Methods

toGValue :: DBusMethodInfo -> IO GValue

fromGValue :: GValue -> IO DBusMethodInfo

tag ~ 'AttrSet => Constructible DBusMethodInfo tag

Defined in GI.Gio.Structs.DBusMethodInfo

Methods

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

newZeroDBusMethodInfo :: MonadIO m => m DBusMethodInfo

Construct a DBusMethodInfo struct initialized to zero.

noDBusMethodInfo :: Maybe DBusMethodInfo

A convenience alias for Nothing :: Maybe DBusMethodInfo.

Methods

Overloaded methods

ref

dBusMethodInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> DBusMethodInfo

info: A DBusMethodInfo

-> m DBusMethodInfo

Returns: The same info.

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

Since: 2.26

unref

dBusMethodInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DBusMethodInfo

info: A DBusMethodInfo.

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

A pointer to a Nothing-terminated array of pointers to DBusAnnotationInfo structures or Nothing if there are no annotations.

clearDBusMethodInfoAnnotations :: MonadIO m => DBusMethodInfo -> m ()

Set the value of the “annotations” field to Nothing. When overloading is enabled, this is equivalent to

clear #annotations

getDBusMethodInfoAnnotations :: MonadIO m => DBusMethodInfo -> m (Maybe [DBusAnnotationInfo])

Get the value of the “annotations” field. When overloading is enabled, this is equivalent to

get dBusMethodInfo #annotations

setDBusMethodInfoAnnotations :: MonadIO m => DBusMethodInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()

Set the value of the “annotations” field. When overloading is enabled, this is equivalent to

set dBusMethodInfo [ #annotations := value ]

inArgs

A pointer to a Nothing-terminated array of pointers to DBusArgInfo structures or Nothing if there are no in arguments.

clearDBusMethodInfoInArgs :: MonadIO m => DBusMethodInfo -> m ()

Set the value of the “in_args” field to Nothing. When overloading is enabled, this is equivalent to

clear #inArgs

getDBusMethodInfoInArgs :: MonadIO m => DBusMethodInfo -> m (Maybe [DBusArgInfo])

Get the value of the “in_args” field. When overloading is enabled, this is equivalent to

get dBusMethodInfo #inArgs

setDBusMethodInfoInArgs :: MonadIO m => DBusMethodInfo -> Ptr (Ptr DBusArgInfo) -> m ()

Set the value of the “in_args” field. When overloading is enabled, this is equivalent to

set dBusMethodInfo [ #inArgs := value ]

name

The name of the D-Bus method, e.g. requestName.

clearDBusMethodInfoName :: MonadIO m => DBusMethodInfo -> m ()

Set the value of the “name” field to Nothing. When overloading is enabled, this is equivalent to

clear #name

getDBusMethodInfoName :: MonadIO m => DBusMethodInfo -> m (Maybe Text)

Get the value of the “name” field. When overloading is enabled, this is equivalent to

get dBusMethodInfo #name

setDBusMethodInfoName :: MonadIO m => DBusMethodInfo -> CString -> m ()

Set the value of the “name” field. When overloading is enabled, this is equivalent to

set dBusMethodInfo [ #name := value ]

outArgs

A pointer to a Nothing-terminated array of pointers to DBusArgInfo structures or Nothing if there are no out arguments.

clearDBusMethodInfoOutArgs :: MonadIO m => DBusMethodInfo -> m ()

Set the value of the “out_args” field to Nothing. When overloading is enabled, this is equivalent to

clear #outArgs

getDBusMethodInfoOutArgs :: MonadIO m => DBusMethodInfo -> m (Maybe [DBusArgInfo])

Get the value of the “out_args” field. When overloading is enabled, this is equivalent to

get dBusMethodInfo #outArgs

setDBusMethodInfoOutArgs :: MonadIO m => DBusMethodInfo -> Ptr (Ptr DBusArgInfo) -> m ()

Set the value of the “out_args” field. When overloading is enabled, this is equivalent to

set dBusMethodInfo [ #outArgs := value ]

refCount

The reference count or -1 if statically allocated.

getDBusMethodInfoRefCount :: MonadIO m => DBusMethodInfo -> m Int32

Get the value of the “ref_count” field. When overloading is enabled, this is equivalent to

get dBusMethodInfo #refCount

setDBusMethodInfoRefCount :: MonadIO m => DBusMethodInfo -> Int32 -> m ()

Set the value of the “ref_count” field. When overloading is enabled, this is equivalent to

set dBusMethodInfo [ #refCount := value ]