GI.Gio.Objects.DBusMethodInvocation

Instances of the DBusMethodInvocation class are used when handling D-Bus method calls. It provides a way to asynchronously return results and errors.

The normal way to obtain a DBusMethodInvocation object is to receive it as an argument to the handle_method_call() function in a DBusInterfaceVTable that was passed to g_dbus_connection_register_object().

Exported types

newtype DBusMethodInvocation

Constructors

DBusMethodInvocation (ManagedPtr DBusMethodInvocation)

Instances

GObject DBusMethodInvocation

Methods

gobjectType :: DBusMethodInvocation -> IO GType

IsObject DBusMethodInvocation

IsDBusMethodInvocation DBusMethodInvocation

((~) * info (ResolveDBusMethodInvocationMethod t DBusMethodInvocation), MethodInfo * info DBusMethodInvocation p) => IsLabel t (DBusMethodInvocation -> p)

Methods

fromLabel :: Proxy# Symbol t -> DBusMethodInvocation -> p

((~) * info (ResolveDBusMethodInvocationMethod t DBusMethodInvocation), MethodInfo * info DBusMethodInvocation p) => IsLabelProxy t (DBusMethodInvocation -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> DBusMethodInvocation -> p

HasAttributeList * DBusMethodInvocation

type AttributeList DBusMethodInvocation

type AttributeList DBusMethodInvocation

type SignalList DBusMethodInvocation

type SignalList DBusMethodInvocation

class GObject o => IsDBusMethodInvocation o

Instances

(GObject a, UnknownAncestorError Constraint DBusMethodInvocation a) => IsDBusMethodInvocation a

IsDBusMethodInvocation DBusMethodInvocation

toDBusMethodInvocation :: IsDBusMethodInvocation o => o -> IO DBusMethodInvocation

noDBusMethodInvocation :: Maybe DBusMethodInvocation

Methods

getConnection

data DBusMethodInvocationGetConnectionMethodInfo

Instances

((~) * signature (m DBusConnection), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetConnectionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetConnectionMethodInfo a -> signature -> s

dBusMethodInvocationGetConnection

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m DBusConnection

Returns: A DBusConnection. Do not free, it is owned by invocation.

Gets the DBusConnection the method was invoked on.

Since: 2.26

getInterfaceName

data DBusMethodInvocationGetInterfaceNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetInterfaceNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetInterfaceNameMethodInfo a -> signature -> s

dBusMethodInvocationGetInterfaceName

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m Text

Returns: A string. Do not free, it is owned by invocation.

Gets the name of the D-Bus interface the method was invoked on.

If this method call is a property Get, Set or GetAll call that has been redirected to the method call handler then "org.freedesktop.DBus.Properties" will be returned. See DBusInterfaceVTable for more information.

Since: 2.26

getMessage

data DBusMethodInvocationGetMessageMethodInfo

Instances

((~) * signature (m DBusMessage), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetMessageMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetMessageMethodInfo a -> signature -> s

dBusMethodInvocationGetMessage

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m DBusMessage

Returns: DBusMessage. Do not free, it is owned by invocation.

Gets the DBusMessage for the method invocation. This is useful if you need to use low-level protocol features, such as UNIX file descriptor passing, that cannot be properly expressed in the GVariant API.

See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.

Since: 2.26

getMethodInfo

data DBusMethodInvocationGetMethodInfoMethodInfo

Instances

((~) * signature (m DBusMethodInfo), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetMethodInfoMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetMethodInfoMethodInfo a -> signature -> s

dBusMethodInvocationGetMethodInfo

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m DBusMethodInfo

Returns: A DBusMethodInfo or Nothing. Do not free, it is owned by invocation.

Gets information about the method call, if any.

If this method invocation is a property Get, Set or GetAll call that has been redirected to the method call handler then Nothing will be returned. See dBusMethodInvocationGetPropertyInfo and DBusInterfaceVTable for more information.

Since: 2.26

getMethodName

data DBusMethodInvocationGetMethodNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetMethodNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetMethodNameMethodInfo a -> signature -> s

dBusMethodInvocationGetMethodName

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m Text

Returns: A string. Do not free, it is owned by invocation.

Gets the name of the method that was invoked.

Since: 2.26

getObjectPath

data DBusMethodInvocationGetObjectPathMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetObjectPathMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetObjectPathMethodInfo a -> signature -> s

dBusMethodInvocationGetObjectPath

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m Text

Returns: A string. Do not free, it is owned by invocation.

Gets the object path the method was invoked on.

Since: 2.26

getParameters

data DBusMethodInvocationGetParametersMethodInfo

Instances

((~) * signature (m GVariant), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetParametersMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetParametersMethodInfo a -> signature -> s

dBusMethodInvocationGetParameters

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m GVariant

Returns: A GVariant tuple. Do not unref this because it is owned by invocation.

Gets the parameters of the method invocation. If there are no input parameters then this will return a GVariant with 0 children rather than NULL.

Since: 2.26

getPropertyInfo

data DBusMethodInvocationGetPropertyInfoMethodInfo

Instances

((~) * signature (m DBusPropertyInfo), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetPropertyInfoMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetPropertyInfoMethodInfo a -> signature -> s

dBusMethodInvocationGetPropertyInfo

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation

-> m DBusPropertyInfo

Returns: a DBusPropertyInfo or Nothing

Gets information about the property that this method call is for, if any.

This will only be set in the case of an invocation in response to a property Get or Set call that has been directed to the method call handler for an object on account of its property_get() or property_set() vtable pointers being unset.

See DBusInterfaceVTable for more information.

If the call was GetAll, Nothing will be returned.

Since: 2.38

getSender

data DBusMethodInvocationGetSenderMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationGetSenderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationGetSenderMethodInfo a -> signature -> s

dBusMethodInvocationGetSender

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> m Text

Returns: A string. Do not free, it is owned by invocation.

Gets the bus name that invoked the method.

Since: 2.26

returnDbusError

data DBusMethodInvocationReturnDbusErrorMethodInfo

Instances

((~) * signature (Text -> Text -> m ()), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationReturnDbusErrorMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationReturnDbusErrorMethodInfo a -> signature -> s

dBusMethodInvocationReturnDbusError

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> Text

errorName: A valid D-Bus error name.

-> Text

errorMessage: A valid D-Bus error message.

-> m ()

Finishes handling a D-Bus method call by returning an error.

This method will free invocation, you cannot use it afterwards.

Since: 2.26

returnErrorLiteral

data DBusMethodInvocationReturnErrorLiteralMethodInfo

Instances

((~) * signature (Word32 -> Int32 -> Text -> m ()), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationReturnErrorLiteralMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationReturnErrorLiteralMethodInfo a -> signature -> s

dBusMethodInvocationReturnErrorLiteral

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> Word32

domain: A GQuark for the GError error domain.

-> Int32

code: The error code.

-> Text

message: The error message.

-> m ()

Like g_dbus_method_invocation_return_error() but without printf()-style formatting.

This method will free invocation, you cannot use it afterwards.

Since: 2.26

returnGerror

data DBusMethodInvocationReturnGerrorMethodInfo

Instances

((~) * signature (GError -> m ()), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationReturnGerrorMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationReturnGerrorMethodInfo a -> signature -> s

dBusMethodInvocationReturnGerror

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> GError

error: A GError.

-> m ()

Like g_dbus_method_invocation_return_error() but takes a GError instead of the error domain, error code and message.

This method will free invocation, you cannot use it afterwards.

Since: 2.26

returnValue

data DBusMethodInvocationReturnValueMethodInfo

Instances

((~) * signature (Maybe GVariant -> m ()), MonadIO m, IsDBusMethodInvocation a) => MethodInfo * DBusMethodInvocationReturnValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationReturnValueMethodInfo a -> signature -> s

dBusMethodInvocationReturnValue

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a)

=> a

invocation: A DBusMethodInvocation.

-> Maybe GVariant

parameters: A GVariant tuple with out parameters for the method or Nothing if not passing any parameters.

-> m ()

Finishes handling a D-Bus method call by returning parameters. If the parameters GVariant is floating, it is consumed.

It is an error if parameters is not of the right format.

This method will free invocation, you cannot use it afterwards.

Since 2.48, if the method call requested for a reply not to be sent then this call will sink parameters and free invocation, but otherwise do nothing (as per the recommendations of the D-Bus specification).

Since: 2.26

returnValueWithUnixFdList

data DBusMethodInvocationReturnValueWithUnixFdListMethodInfo

Instances

((~) * signature (Maybe GVariant -> Maybe b -> m ()), MonadIO m, IsDBusMethodInvocation a, IsUnixFDList b) => MethodInfo * DBusMethodInvocationReturnValueWithUnixFdListMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusMethodInvocationReturnValueWithUnixFdListMethodInfo a -> signature -> s

dBusMethodInvocationReturnValueWithUnixFdList

Arguments

:: (HasCallStack, MonadIO m, IsDBusMethodInvocation a, IsUnixFDList b)

=> a

invocation: A DBusMethodInvocation.

-> Maybe GVariant

parameters: A GVariant tuple with out parameters for the method or Nothing if not passing any parameters.

-> Maybe b

fdList: A UnixFDList or Nothing.

-> m ()

Like dBusMethodInvocationReturnValue but also takes a UnixFDList.

This method is only available on UNIX.

This method will free invocation, you cannot use it afterwards.

Since: 2.30