Interface

Jsonrpc-1.0JsonrpcClientSignalSignatures

interface SignalSignatures {
    failed: () => void;
    "handle-call": (
        arg0: string,
        arg1: GLib.Variant,
        arg2: GLib.Variant<any>,
    ) => boolean | void;
    "handle-call::io-stream": (
        arg0: string,
        arg1: GLib.Variant,
        arg2: GLib.Variant<any>,
    ) => boolean | void;
    "handle-call::use-gvariant": (
        arg0: string,
        arg1: GLib.Variant,
        arg2: GLib.Variant<any>,
    ) => boolean | void;
    notification: (arg0: string, arg1: GLib.Variant<any>) => void;
    "notification::io-stream": (arg0: string, arg1: GLib.Variant<any>) => void;
    "notification::use-gvariant": (
        arg0: string,
        arg1: GLib.Variant<any>,
    ) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::io-stream": (pspec: GObject.ParamSpec) => void;
    "notify::use-gvariant": (pspec: GObject.ParamSpec) => void;
}

Hierarchy (View Summary)

Index

Properties

failed: () => void

The "failed" signal is called when the client has failed communication or the connection has been knowingly closed.

3.28

"handle-call": (
    arg0: string,
    arg1: GLib.Variant,
    arg2: GLib.Variant<any>,
) => boolean | void

This signal is emitted when an RPC has been received from the peer we are connected to. Return true if you have handled this message, even asynchronously. If no handler has returned true an error will be synthesized.

If you handle the message, you are responsible for replying to the peer in a timely manner using Client.reply or Client.reply_async.

Additionally, since 3.28 you may connect to the "detail" of this signal to handle a specific method call. Use the method name as the detail of the signal.

3.26

"handle-call::io-stream": (
    arg0: string,
    arg1: GLib.Variant,
    arg2: GLib.Variant<any>,
) => boolean | void

This signal is emitted when an RPC has been received from the peer we are connected to. Return true if you have handled this message, even asynchronously. If no handler has returned true an error will be synthesized.

If you handle the message, you are responsible for replying to the peer in a timely manner using Client.reply or Client.reply_async.

Additionally, since 3.28 you may connect to the "detail" of this signal to handle a specific method call. Use the method name as the detail of the signal.

3.26

"handle-call::use-gvariant": (
    arg0: string,
    arg1: GLib.Variant,
    arg2: GLib.Variant<any>,
) => boolean | void

This signal is emitted when an RPC has been received from the peer we are connected to. Return true if you have handled this message, even asynchronously. If no handler has returned true an error will be synthesized.

If you handle the message, you are responsible for replying to the peer in a timely manner using Client.reply or Client.reply_async.

Additionally, since 3.28 you may connect to the "detail" of this signal to handle a specific method call. Use the method name as the detail of the signal.

3.26

notification: (arg0: string, arg1: GLib.Variant<any>) => void

This signal is emitted when a notification has been received from a peer. Unlike Jsonrpc.Client::handle-call, this does not have an "id" parameter because notifications do not have ids. They do not round trip.

3.26

"notification::io-stream": (arg0: string, arg1: GLib.Variant<any>) => void

This signal is emitted when a notification has been received from a peer. Unlike Jsonrpc.Client::handle-call, this does not have an "id" parameter because notifications do not have ids. They do not round trip.

3.26

"notification::use-gvariant": (arg0: string, arg1: GLib.Variant<any>) => void

This signal is emitted when a notification has been received from a peer. Unlike Jsonrpc.Client::handle-call, this does not have an "id" parameter because notifications do not have ids. They do not round trip.

3.26

"notify::io-stream": (pspec: GObject.ParamSpec) => void
"notify::use-gvariant": (pspec: GObject.ParamSpec) => void

Properties - Inherited from GObject

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
G_CALLBACK (gtk_text_view_target_list_notify),
text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.