TpBaseChannel

typedef struct _TpBaseChannel TpBaseChannel;

A base class for channel implementations

Since 0.11.14

struct TpBaseChannelClass

struct TpBaseChannelClass {
  TpDBusPropertiesMixinClass dbus_props_class;

  const gchar *channel_type;
  TpHandleType target_handle_type;
  const gchar **interfaces;

  TpBaseChannelCloseFunc close;
  TpBaseChannelFillPropertiesFunc fill_immutable_properties;
  TpBaseChannelGetPathFunc get_object_path_suffix;
  TpBaseChannelGetInterfacesFunc get_interfaces;
};

The class structure for TpBaseChannel

Since 0.11.14

TpBaseChannelFillPropertiesFunc ()

void                (*TpBaseChannelFillPropertiesFunc)  (TpBaseChannel *chan,
                                                         GHashTable *properties);

Signature of an implementation of the TpBaseChannelClass.fill_immutable_properties virtual function. A typical implementation, for a channel implementing TpSvcChannelTypeContactSearch, would be:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

static void
my_search_channel_fill_properties (
    TpBaseChannel *chan,
    GHashTable *properties)
{
  TpBaseChannelClass *klass = TP_BASE_CHANNEL_CLASS (my_search_channel_parent_class);

  klass->fill_immutable_properties (chan, properties);

  tp_dbus_properties_mixin_fill_properties_hash (
      G_OBJECT (chan), properties,
      TP_IFACE_CHANNEL_TYPE_CONTACT_SEARCH, "Limit",
      TP_IFACE_CHANNEL_TYPE_CONTACT_SEARCH, "AvailableSearchKeys",
      TP_IFACE_CHANNEL_TYPE_CONTACT_SEARCH, "Server",
      NULL);
}

Note that the SearchState property is not added to properties, since only immutable properties (whose value cannot change over the lifetime of chan) should be included.

Since 0.11.14

TpBaseChannelCloseFunc ()

void                (*TpBaseChannelCloseFunc)           (TpBaseChannel *chan);

Signature of an implementation of the TpBaseChannelClass.close virtual function. Implementations should eventually call either tp_base_channel_destroyed() if the channel is really closed as a result, or tp_base_channel_reopened() if the channel will be re-spawned (for instance, due to unacknowledged messages on a text channel), but need not do so before returning. Note that channels that support re-spawning must also implement TpSvcChannelInterfaceDestroyable.

Implementations may assume that tp_base_channel_is_destroyed() is FALSE for chan when called. Note that if this function is implemented asynchronously, it may be called more than once. A subclass which needs to perform some asynchronous clean-up in order to close might implement this function as follows:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

static void
my_channel_close (TpBaseChannel *chan)
{
  MyChannel *self = MY_CHANNEL (chan);

  if (self->priv->closing)
    return;

  self->priv->closing = TRUE;

  // some hypothetical channel-specific clean-up function:
  clean_up (self, cleaned_up_cb);
}

static void
cleaned_up_cb (MyChannel *self)
{
  // all done, we can finish closing now
  tp_base_channel_destroyed (TP_BASE_CHANNEL (self));
}
static void
my_channel_class_init (MyChannelClass *klass)
{
  TpBaseChannelClass *base_channel_class = TP_BASE_CHANNEL_CLASS (klass);

  klass->close = my_channel_close;
  // ...
}

If a subclass does not need to do anything to clean itself up, it may implement TpBaseChannelClass.close using tp_base_channel_destroyed() directly:

1
2
3
4
5
6
7
8

static void
my_channel_class_init (MyChannelClass *klass)
{
  TpBaseChannelClass *base_channel_class = TP_BASE_CHANNEL_CLASS (klass);

  klass->close = tp_base_channel_destroyed;
  // ...
}

Since 0.11.14

TpBaseChannelGetPathFunc ()

gchar *             (*TpBaseChannelGetPathFunc)         (TpBaseChannel *chan);

Signature of an implementation of the TpBaseChannelClass.get_object_path_suffix virtual function.

Since 0.11.14

TpBaseChannelGetInterfacesFunc ()

GPtrArray *         (*TpBaseChannelGetInterfacesFunc)   (TpBaseChannel *chan);

Signature of an implementation of TpBaseChannelClass.get_interfaces virtual function.

Implementation must first chainup on parent class implementation and then add extra interfaces into the GPtrArray.

1
2
3
4
5
6
7
8
9
10
11

static GPtrArray *
my_channel_get_interfaces (TpBaseChannel *self)
{
  GPtrArray *interfaces;

  interfaces = TP_BASE_CHANNEL_CLASS (my_channel_parent_class)->get_interfaces (self);

  g_ptr_array_add (interfaces, TP_IFACE_BADGERS);

  return interfaces;
}

Since 0.17.5

tp_base_channel_register ()

void                tp_base_channel_register            (TpBaseChannel *chan);

Make the channel appear on the bus. "object-path" must have been set to a valid path, which must not already be in use as another object's path.

Since 0.11.14

tp_base_channel_close ()

void                tp_base_channel_close               (TpBaseChannel *chan);

Asks chan to close, just as if the Close D-Bus method had been called. If "channel-destroyed" is TRUE, this is a no-op.

Note that, depending on the subclass's implementation of TpBaseChannelClass.close and internal behaviour, this may or may not be a suitable method to use during connection teardown. For instance, if the channel may respawn when Close is called, an equivalent of the Destroy D-Bus method would be more appropriate during teardown, since the intention is to forcibly terminate all channels.

Since 0.11.14

tp_base_channel_destroyed ()

void                tp_base_channel_destroyed           (TpBaseChannel *chan);

Called by subclasses to indicate that this channel was destroyed and can be removed from the bus. The "Closed" signal will be emitted and the "channel-destroyed" property will be set.

Since 0.11.14

tp_base_channel_reopened ()

void                tp_base_channel_reopened            (TpBaseChannel *chan,
                                                         TpHandle initiator);

Called by subclasses to indicate that this channel was closed but was re-opened due to pending messages. The "Closed" signal will be emitted, but the "channel-destroyed" property will not be set. The channel's "initiator-handle" property will be set to initiator, and the "requested" property will be set to FALSE.

Since 0.11.14

tp_base_channel_get_object_path ()

const gchar *       tp_base_channel_get_object_path     (TpBaseChannel *chan);

Returns chan's object path, as a shortcut for retrieving the "object-path" property.

Since 0.11.14

tp_base_channel_get_connection ()

TpBaseConnection *  tp_base_channel_get_connection      (TpBaseChannel *chan);

Returns the connection to which chan is attached, as a shortcut for retrieving the "connection" property.

Since 0.11.14

tp_base_channel_get_self_handle ()

TpHandle            tp_base_channel_get_self_handle     (TpBaseChannel *chan);

If chan has a TpGroupMixin, returns the value of group's self handle. Otherwise return the value of "self-handle".

Since 0.17.5

tp_base_channel_get_target_handle ()

TpHandle            tp_base_channel_get_target_handle   (TpBaseChannel *chan);

Returns the target handle of chan (without a reference), which will be 0 if TpBaseChannelClass.target_handle_type is TP_HANDLE_TYPE_NONE for this class, and non-zero otherwise. This is a shortcut for retrieving the "handle" property. The reference count of the handle is not increased; you should use tp_handle_ref() if you want to keep a hold of it.

Since 0.11.14

tp_base_channel_get_initiator ()

TpHandle            tp_base_channel_get_initiator       (TpBaseChannel *chan);

Returns the initiator handle of chan, as a shortcut for retrieving the "initiator-handle" property. The reference count of the handle is not increased; you should use tp_handle_ref() if you want to keep a hold of it.

Since 0.11.14

tp_base_channel_is_requested ()

gboolean            tp_base_channel_is_requested        (TpBaseChannel *chan);

Returns whether or not chan was requested, as a shortcut for retrieving the "requested" property.

Since 0.11.14

tp_base_channel_is_registered ()

gboolean            tp_base_channel_is_registered       (TpBaseChannel *chan);

Returns whether or not chan is visible on the bus; that is, whether tp_base_channel_register() has been called and tp_base_channel_destroyed() has not been called.

Since 0.11.14

tp_base_channel_is_destroyed ()

gboolean            tp_base_channel_is_destroyed        (TpBaseChannel *chan);

Returns the value of the "channel-destroyed" property, which is TRUE if tp_base_channel_destroyed() has been called (and thus the channel has been removed from the bus).

Since 0.11.14

The "connection" property

  "connection"               TpBaseConnection*     : Read / Write / Construct Only

Connection object that owns this channel.

The "initiator-handle" property

  "initiator-handle"         guint                 : Read / Write / Construct Only

The contact who initiated the channel.

Default value: 0

The "initiator-id" property

  "initiator-id"             gchar*                : Read

The string obtained by inspecting the initiator-handle.

Default value: NULL

The "interfaces" property

  "interfaces"               GStrv                 : Read

Additional Channel.Interface.* interfaces.

The "requested" property

  "requested"                gboolean              : Read / Write / Construct Only

True if this channel was requested by the local user.

Default value: FALSE

The "target-id" property

  "target-id"                gchar*                : Read

The string obtained by inspecting the target handle.

Default value: NULL