Gjsify LogoGjsify Logo

A client for JSON-RPC communication

The #JsonrpcClient class provides a convenient API to coordinate with a JSON-RPC server. You can provide the underlying [classGio.IOStream] to communicate with allowing you to control the negotiation of how you setup your communications channel. One such method might be to use a [classGio.Subprocess] and communicate over stdin and stdout.

Because JSON-RPC allows for out-of-band notifications from the server to the client, it is important that the consumer of this API calls [methodClient.close] or [methodClient.close_async] when they no longer need the client. This is because #JsonrpcClient contains an asynchronous read-loop to process incoming messages. Until [methodClient.close] or [methodClient.close_async] have been called, this read loop will prevent the object from finalizing (being freed).

To make an RPC call, use [methodClient.call] or [methodClient.call_async] and provide the method name and the parameters as a [structGLib.Variant] for call.

It is a programming error to mix synchronous and asynchronous API calls of the #JsonrpcClient class.

For synchronous calls, #JsonrpcClient will use the thread-default [structGLib.MainContext]. If you have special needs here ensure you've set the context before calling into any #JsonrpcClient API.

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
ioStream: IOStream

The "io-stream" property is the [classGio.IOStream] to use for communicating with a JSON-RPC peer.

parentInstance: GObject.Object
useGvariant: boolean

The "use-gvariant" property denotes if [structGLib.Variant] should be used to communicate with the peer instead of JSON. You should only set this if you know the peer is also a Jsonrpc-GLib based client.

Setting this property allows the peers to communicate using GVariant instead of JSON. This means that we can access the messages without expensive memory allocations and parsing costs associated with JSON. [structGLib.Variant] is much more optimal for memory-bassed message passing.

name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • Synchronously calls method with params on the remote peer.

    once a reply has been received, or failure, this function will return. If successful, return_value will be set with the reslut field of the response.

    If params is floating then this function consumes the reference.

    Parameters

    • method: string

      The name of the method to call

    • params: GLib.Variant

      A [structGLib.Variant] of parameters or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL

    Returns [boolean, GLib.Variant]

  • Asynchronously calls method with params on the remote peer.

    Upon completion or failure, callback is executed and it should call [methodClient.call_finish] to complete the request and release any memory held.

    If params is floating, the floating reference is consumed.

    Parameters

    • method: string

      The name of the method to call

    • params: GLib.Variant

      A [structGLib.Variant] of parameters or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL

    • callback: AsyncReadyCallback

      a callback to executed upon completion

    Returns void

  • Completes an asynchronous call to [methodClient.call_async].

    Parameters

    • result: AsyncResult

      A #GAsyncResult provided to the callback in [methodClient.call_async]

    Returns [boolean, GLib.Variant]

  • Asynchronously calls method with params on the remote peer.

    Upon completion or failure, callback is executed and it should call [methodClient.call_finish] to complete the request and release any memory held.

    This function is similar to [methodClient.call_async] except that it allows the caller to get the id of the command which might be useful in systems where you can cancel the operation (such as the Language Server Protocol).

    If params is floating, the floating reference is consumed.

    Parameters

    • method: string

      The name of the method to call

    • params: GLib.Variant

      A [structGLib.Variant] of parameters or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL

    • callback: AsyncReadyCallback

      Callback to executed upon completion

    Returns GLib.Variant

  • Closes the underlying streams and cancels any inflight operations of the #JsonrpcClient.

    This is important to call when you are done with the client so that any outstanding operations that have caused self to hold additional references are cancelled.

    Failure to call this method results in a leak of #JsonrpcClient.

    Parameters

    Returns boolean

  • Asynchronous version of [methodClient.close].

    Currently this operation is implemented synchronously, but in the future may be converted to using asynchronous operations.

    Parameters

    Returns void

  • connect(sigName: "failed", callback: Client_FailedSignalCallback): number
  • connect(sigName: "handle-call", callback: Client_HandleCallSignalCallback): number
  • connect(sigName: "notification", callback: Client_NotificationSignalCallback): number
  • connect(sigName: "notify::io-stream", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::use-gvariant", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • emit(sigName: "failed", ...args: any[]): void
  • emit(sigName: "handle-call", id: GLib.Variant, params: GLib.Variant, ...args: any[]): void
  • emit(sigName: "notification", params: GLib.Variant, ...args: any[]): void
  • emit(sigName: "notify::io-stream", ...args: any[]): void
  • emit(sigName: "notify::use-gvariant", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getUseGvariant(): boolean
  • Gets the [propertyClient:use-gvariant] property.

    Indicates if [structGLib.Variant] is being used to communicate with the peer.

    Returns boolean

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "failed", callback: Client_FailedSignalCallback): EventEmitter
  • off(sigName: "handle-call", callback: Client_HandleCallSignalCallback): EventEmitter
  • off(sigName: "notification", callback: Client_NotificationSignalCallback): EventEmitter
  • off(sigName: "notify::io-stream", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::use-gvariant", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • on(sigName: "failed", callback: Client_FailedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "handle-call", callback: Client_HandleCallSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notification", callback: Client_NotificationSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::io-stream", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::use-gvariant", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "failed", callback: Client_FailedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "handle-call", callback: Client_HandleCallSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notification", callback: Client_NotificationSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::io-stream", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::use-gvariant", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • Synchronous variant of [methodClient.reply_async].

    If id or result are floating, there floating references are consumed.

    Parameters

    Returns boolean

  • Asynchronously replies to the peer, sending a JSON-RPC error message.

    Call [methodClient.reply_error_finish] to get the result of this operation.

    If id is floating, it's floating reference is consumed.

    Parameters

    • id: GLib.Variant

      A [structGLib.Variant] containing the call id

    • code: number

      The error code

    • message: string

      An optional error message

    • cancellable: Gio.Cancellable

      A #GCancellable, or %NULL

    • callback: AsyncReadyCallback

      A #GAsyncReadyCallback or %NULL

    Returns void

  • Completes an asynchronous request to [methodClient.reply_async].

    Parameters

    Returns boolean

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Synchronously calls method with params on the remote peer.

    This function will not wait or expect a reply from the peer.

    If params is floating then the reference is consumed.

    Parameters

    • method: string

      The name of the method to call

    • params: GLib.Variant

      A [structGLib.Variant] of parameters or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL

    Returns boolean

  • Asynchronously calls method with params on the remote peer.

    This function will not wait or expect a reply from the peer.

    This function is useful when the caller wants to be notified that the bytes have been delivered to the underlying stream. This does not indicate that the peer has received them.

    If params is floating then the reference is consumed.

    Parameters

    Returns void

  • Completes an asynchronous call to [methodClient.send_notification_async].

    Successful completion of this function only indicates that the request has been written to the underlying buffer, not that the peer has received the notification.

    Parameters

    Returns boolean

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setUseGvariant(useGvariant: boolean): void
  • Sets the [propertyClient:use-gvariant] property.

    This function sets if [structGLib.Variant] should be used to communicate with the peer. Doing so can allow for more efficient communication by avoiding expensive parsing overhead and memory allocations. However, it requires that the peer also supports [structGLib.Variant] encoding.

    Parameters

    • useGvariant: boolean

      If [structGLib.Variant] should be used

    Returns void

  • startListening(): void
  • This function requests that client start processing incoming messages from the peer.

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • errorQuark(): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new #JsonrpcClient instance.

    If you want to communicate with a process using stdin/stdout, consider using [classGio.Subprocess] to launch the process and create a [classGio.SimpleIOStream] using the [methodGio.Subprocess.get_stdin_pipe] and [methodGio.Subprocess.get_stdout_pipe].

    Parameters

    • ioStream: IOStream

      A [classGio.IOStream]

    Returns Jsonrpc.Client

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method