Gjsify LogoGjsify Logo

Data structure representing a generic #TpSvcConnection implementation.

Since 0.19.1, accessing the fields of this structure is deprecated. Use tp_base_connection_get_bus_name(), tp_base_connection_get_object_path(), tp_base_connection_get_status(), tp_base_connection_get_self_handle() instead.

Hierarchy

Index

Constructors

Properties

accountPathSuffix: string

The suffix of the account object path such as "gabble/jabber/chris_40example_2ecom0" for the account whose object path is %TP_ACCOUNT_OBJECT_PATH_BASE + "gabble/jabber/chris_40example_2ecom0". The same as returned by tp_account_get_path_suffix().

It is given by the AccountManager in the connection parameters. Or %NULL if the ConnectionManager or the AccountManager are too old.

gTypeInstance: TypeInstance
hasImmortalHandles: boolean

This property is not useful to use directly. Its value is %TRUE, to indicate that this version of telepathy-glib never unreferences handles until the connection becomes disconnected.

name: string

Methods

  • addClientInterest(uniqueName: string, token: string, onlyIfUninterested: boolean): void
  • Add a "client interest" for token on behalf of the given client.

    This emits #TpBaseConnection::clients-interested if this was the first time a client expressed an interest in this token.

    Parameters

    • uniqueName: string

      the unique bus name of a D-Bus client

    • token: string

      a D-Bus interface or a token representing part of an interface, added with tp_base_connection_add_possible_client_interest()

    • onlyIfUninterested: boolean

      only add to the interest count if the client is not already interested (appropriate for APIs that implicitly subscribe on first use if this has not been done already, like Location)

    Returns void

  • addPossibleClientInterest(token: number): void
  • Add token to the set of tokens for which this connection will emit #TpBaseConnection::clients-interested and #TpBaseConnection::clients-uninterested.

    This method must be called from the #GObjectClass.constructed or #GObjectClass.constructor callback (otherwise, it will run too late to be useful).

    Parameters

    • token: number

      a quark corresponding to a D-Bus interface, or a token representing part of a D-Bus interface, for which this connection wishes to be notified when clients register an interest

    Returns void

  • 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

  • Change the status of the connection. The allowed state transitions are:

    #TP_INTERNAL_CONNECTION_STATUS_NEW → #TP_CONNECTION_STATUS_CONNECTING #TP_CONNECTION_STATUS_CONNECTING → #TP_CONNECTION_STATUS_CONNECTED #TP_INTERNAL_CONNECTION_STATUS_NEW → #TP_CONNECTION_STATUS_CONNECTED (exactly equivalent to both of the above one after the other; see below) anything except #TP_CONNECTION_STATUS_DISCONNECTED → #TP_CONNECTION_STATUS_DISCONNECTED

    Before the transition to #TP_CONNECTION_STATUS_CONNECTED, the implementation must have discovered the handle for the local user and passed it to tp_base_connection_set_self_handle().

    Changing from NEW to CONNECTED is implemented by doing the transition from NEW to CONNECTING, followed by the transition from CONNECTING to CONNECTED; it's exactly equivalent to calling tp_base_connection_change_status for those two transitions one after the other.

    Any other valid transition does the following, in this order:

    Update #TpBaseConnection.status; If the new state is #TP_CONNECTION_STATUS_DISCONNECTED, call tp_channel_factory_iface_close_all() on all channel factories Emit the D-Bus StatusChanged signal; Call #TpBaseConnectionClass.connecting, #TpBaseConnectionClass.connected or #TpBaseConnectionClass.disconnected as appropriate; Call the channel factories' status change callbacks; If the new state is #TP_CONNECTION_STATUS_DISCONNECTED, call the subclass' #TpBaseConnectionClass.shut_down callback.

    To provide more details about what happened when moving to status #TP_CONNECTION_STATUS_DISCONNECTED due to an error, consider calling tp_base_connection_disconnect_with_dbus_error() instead of this function.

    Changed in 0.7.35: the self_handle member of #TpBaseConnection was previously set to 0 at this stage. It now remains non-zero until the object is disposed.

    Parameters

    Returns void

  • checkConnected(): boolean
  • Return whether this connection is fully active and connected. If it is not, raise %TP_ERROR_DISCONNECTED.

    This is equivalent to checking whether tp_base_connection_get_status() returns %TP_CONNECTION_STATUS_CONNECTED; it is provided because methods on the connection often need to make this check, and return a #GError if it fails.

    Returns boolean

  • connect(sigName: "clients-interested", callback: BaseConnection_ClientsInterestedSignalCallback): number
  • connect(sigName: "clients-uninterested", callback: BaseConnection_ClientsUninterestedSignalCallback): number
  • connect(sigName: "shutdown-finished", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::account-path-suffix", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::has-immortal-handles", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • emit(sigName: "clients-interested", ...args: any[]): void
  • emit(sigName: "clients-uninterested", ...args: any[]): void
  • emit(sigName: "shutdown-finished", ...args: any[]): void
  • emit(sigName: "notify::account-path-suffix", ...args: any[]): void
  • emit(sigName: "notify::has-immortal-handles", ...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

  • getAccountPathSuffix(): string
  • getBusName(): string
  • Return the bus name starting with %TP_CONN_BUS_NAME_BASE that represents this connection on D-Bus.

    The returned string belongs to the #TpBaseConnection and must be copied by the caller if it will be kept.

    If this connection has never been present on D-Bus (tp_base_connection_register() has never been called), return %NULL instead.

    Returns string

  • 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

  • getObjectPath(): string
  • Return the object path starting with %TP_CONN_OBJECT_PATH_BASE that represents this connection on D-Bus.

    The returned string belongs to the #TpBaseConnection and must be copied by the caller if it will be kept.

    If this connection has never been present on D-Bus (tp_base_connection_register() has never been called), return %NULL instead.

    Returns string

  • 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

  • Return the status of this connection, as set by tp_base_connection_change_status() or similar functions like tp_base_connection_disconnect_with_dbus_error().

    Like the corresponding D-Bus property, this method returns %TP_CONNECTION_STATUS_DISCONNECTED in two situations: either the connection is newly-created (and has never emitted #TpSvcConnection::status-changed), or D-Bus clients have already been told that it has been destroyed (by the Disconnect D-Bus method, a failed attempt to connect, or loss of an established connection). Use tp_base_connection_is_destroyed() to distinguish between the two.

    Returns TelepathyGLib.ConnectionStatus

  • 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

  • isDestroyed(): boolean
  • Return whether this connection has already emitted the D-Bus signal indicating that it has been destroyed.

    In particular, this can be used to distinguish between the two reasons why tp_base_connection_get_status() would return %TP_CONNECTION_STATUS_DISCONNECTED: it will return %FALSE if the connection is newly-created, and %TRUE if the Disconnect D-Bus method has been called, an attempt to connect has failed, or an established connection has encountered an error.

    Returns boolean

  • 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: "clients-interested", callback: BaseConnection_ClientsInterestedSignalCallback): EventEmitter
  • off(sigName: "clients-uninterested", callback: BaseConnection_ClientsUninterestedSignalCallback): EventEmitter
  • off(sigName: "shutdown-finished", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::account-path-suffix", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::has-immortal-handles", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • on(sigName: "clients-interested", callback: BaseConnection_ClientsInterestedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "clients-uninterested", callback: BaseConnection_ClientsUninterestedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "shutdown-finished", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::account-path-suffix", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::has-immortal-handles", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "clients-interested", callback: BaseConnection_ClientsInterestedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "clients-uninterested", callback: BaseConnection_ClientsUninterestedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "shutdown-finished", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::account-path-suffix", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::has-immortal-handles", 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

  • register(cmName: string): [boolean, string, string]
  • Make the connection object appear on the bus, returning the bus name and object path used. If %TRUE is returned, the connection owns the bus name, and will release it when destroyed.

    Since 0.11.11, bus_name and object_path may be %NULL if the strings are not needed.

    Parameters

    • cmName: string

      The name of the connection manager in the Telepathy protocol

    Returns [boolean, string, string]

  • 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

  • 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

  • setSelfHandle(selfHandle: number): void
  • Sets the #TpBaseConnection:self-handle property. self_handle may not be 0 once the connection has moved to the CONNECTED state.

    Parameters

    • selfHandle: number

      The new self handle for the connection.

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