Top |
TpBaseChannelTpBaseChannel — base class for TpExportableChannel implementations |
void | (*TpBaseChannelFillPropertiesFunc) () |
void | (*TpBaseChannelCloseFunc) () |
gchar * | (*TpBaseChannelGetPathFunc) () |
GPtrArray * | (*TpBaseChannelGetInterfacesFunc) () |
void | tp_base_channel_register () |
void | tp_base_channel_close () |
void | tp_base_channel_destroyed () |
void | tp_base_channel_reopened () |
void | tp_base_channel_disappear () |
void | tp_base_channel_reopened_with_requested () |
const gchar * | tp_base_channel_get_object_path () |
TpBaseConnection * | tp_base_channel_get_connection () |
TpHandle | tp_base_channel_get_self_handle () |
TpHandle | tp_base_channel_get_target_handle () |
TpHandle | tp_base_channel_get_initiator () |
gboolean | tp_base_channel_is_requested () |
gboolean | tp_base_channel_is_registered () |
gboolean | tp_base_channel_is_destroyed () |
gboolean | tp_base_channel_is_respawning () |
TpBaseConnection * | connection | Read / Write / Construct Only |
guint | initiator-handle | Read / Write / Construct Only |
gchar * | initiator-id | Read |
GStrv | interfaces | Read |
gboolean | requested | Read / Write / Construct Only |
gchar * | target-id | Read |
TpBaseChannel implements TpSvcDBusProperties, TpSvcChannel, TpChannelIface and TpExportableChannel.
This base class makes it easier to write TpExportableChannel implementations by implementing some of its properties, and defining other relevant properties.
Subclasses should fill in TpBaseChannelClass.channel_type and TpBaseChannelClass.target_handle_type; and implement the TpBaseChannelClass.get_interfaces and TpBaseChannelClass.close virtual functions.
If the channel type and/or interfaces being implemented define immutable D-Bus properties besides those on the Channel interface, the subclass should implement the TpBaseChannelClass.fill_immutable_properties virtual function.
If the “object-path” property is not set at construct time, the TpBaseChannelClass.get_object_path_suffix virtual function will be called to determine the channel's path, whose default implementation simply generates a unique path based on the object's address in memory.
TpBaseChannel also has the ability to remove the channel from the
bus, but keep the object around. To close the channel and remove it
from the bus, subclasses should call
tp_base_channel_disappear()
. To bring the channel back, subclasses
use tp_base_channel_reopened_with_requested()
and the channel
should be re-announced with
tp_channel_manager_emit_new_channel()
. Note that channels which can
disappear but can also reopen due to pending messages need special
casing by the channel manager:
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 29 30 31 |
static void channel_closed_cb (TpBaseChannel *chan, TpChannelManager *manager) { MyChannelManager *self = MY_CHANNEL_MANAGER (manager); TpHandle handle = tp_base_channel_get_target_handle (chan); // first, emit ChannelClosed if the channel is registered (it // won't be registered if it is appearing from being hidden, so // let's not emit the signal in this case) if (tp_base_channel_is_registered (chan)) { tp_channel_manager_emit_channel_closed (manager, TP_EXPORTABLE_CHANNEL (chan)); } if (tp_base_channel_is_destroyed (chan)) { // destroyed() must have been called; forget this channel g_hash_table_remove (self->priv->channels, handle); } else if (tp_base_channel_is_respawning (chan)) { // reopened_with_requested() must have been called; re-announce the channel tp_channel_manager_emit_new_channel (manager, TP_EXPORTABLE_CHANNEL (chan)); } else { // disappear() must have been called, do nothing special } } |
and the TpChannelManagerIface.foreach_channel virtual function should be updated to only include registered channels:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
static void foreach_channel (TpChannelManager *manager, TpChannelManagerChannelClassFunc func, gpointer user_data) { MyChannelManager *self = MY_CHANNEL_MANAGER (manager); GHashTableIter iter; gpointer chan; g_hash_table_iter_init (&iter, self->priv->channels); while (g_hash_table_iter_next (&iter, NULL, &chan)) { if (tp_base_channel_is_registered (TP_BASE_CHANNEL (chan))) func (TP_EXPORTABLE_CHANNEL (chan), user_data); } } |
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.
chan |
a channel |
|
properties |
a dictionary of |
Since: 0.11.14
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
gchar *
(*TpBaseChannelGetPathFunc) (TpBaseChannel *chan
);
Signature of an implementation of the TpBaseChannelClass.get_object_path_suffix virtual function.
a string that will be appended to the Connection objects's object path to get the Channel's object path.
[transfer full]
Since: 0.11.14
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; } |
a GPtrArray of static strings for D-Bus interfaces implemented by this client.
[transfer container]
Since: 0.17.5
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
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
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
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.
Calling this method is the same as calling
tp_base_channel_reopened_with_requested()
with a requested value of
FALSE
.
Since: 0.11.14
void
tp_base_channel_disappear (TpBaseChannel *chan
);
Called by subclasses to indicate that this channel is closing and should be unregistered from the bus, but the actual object shouldn't be destroyed. The "Closed" signal will be emitted, the “channel-destroyed” property will not be set, and the channel will be unregistered from the bus.
Since: 0.19.7
void tp_base_channel_reopened_with_requested (TpBaseChannel *chan
,gboolean requested
,TpHandle initiator
);
Called by subclasses to indicate that this channel was closed but
was re-opened, either due to pending messages or from having
disappeared (with tp_base_channel_disappear()
). 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
requested
.
chan |
a channel |
|
requested |
|
|
initiator |
the handle of the contact that re-opened the channel |
Since: 0.19.7
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
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
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
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.
Since: 0.11.14
TpHandle
tp_base_channel_get_initiator (TpBaseChannel *chan
);
Returns the initiator handle of chan
, as a shortcut for retrieving the
“initiator-handle” property.
Since: 0.11.14
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
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
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
gboolean
tp_base_channel_is_respawning (TpBaseChannel *chan
);
Returns TRUE
if the channel has been reopened, either by a
subclass calling tp_base_channel_reopened()
or
tp_base_channel_reopened_with_requested()
. This is useful for
"closed" handlers to distinguish between channels really closing
and channels that have been reopened due to pending messages.
TRUE
if tp_base_channel_reopened()
or
tp_base_channel_reopened_with_requested()
have been called.
Since: 0.19.7
struct TpBaseChannelClass { TpDBusPropertiesMixinClass dbus_props_class; const gchar *channel_type; TpHandleType target_handle_type; TpBaseChannelCloseFunc close; TpBaseChannelFillPropertiesFunc fill_immutable_properties; TpBaseChannelGetPathFunc get_object_path_suffix; TpBaseChannelGetInterfacesFunc get_interfaces; };
The class structure for TpBaseChannel
TpDBusPropertiesMixinClass |
The class structure for the DBus properties mixin |
|
The type of channel that instances of this class represent (e.g. TP_IFACE_CHANNEL_TYPE_TEXT) |
||
TpHandleType |
The type of handle that is the target of channels of this type |
|
TpBaseChannelCloseFunc |
A virtual function called to close the channel, which will be called
by |
|
TpBaseChannelFillPropertiesFunc |
A virtual function called to add custom
properties to the DBus properties hash. Implementations must chain up to the
parent class implementation and call
|
|
TpBaseChannelGetPathFunc |
Returns a string that will be appended to the Connection objects's object path to get the Channel's object path. This function will only be called as a fallback if the “object-path” property is not set. The default implementation simply generates a unique path based on the object's address in memory. The returned string will be freed automatically. |
|
TpBaseChannelGetInterfacesFunc |
Extra interfaces provided by this channel (this SHOULD NOT
include the channel type and interface itself). Implementation must first
chainup on parent class implementation and then add extra interfaces into
the GPtrArray. Replaces |
Since: 0.11.14
“connection”
property“connection” TpBaseConnection *
Connection object that owns this channel.
Owner: TpBaseChannel
Flags: Read / Write / Construct Only
“initiator-handle”
property “initiator-handle” guint
The contact who initiated the channel.
Owner: TpBaseChannel
Flags: Read / Write / Construct Only
Default value: 0
“initiator-id”
property “initiator-id” gchar *
The string obtained by inspecting the initiator-handle.
Owner: TpBaseChannel
Flags: Read
Default value: NULL
“interfaces”
property “interfaces” GStrv
Additional Channel.Interface.* interfaces.
Owner: TpBaseChannel
Flags: Read
“requested”
property “requested” gboolean
True if this channel was requested by the local user.
Owner: TpBaseChannel
Flags: Read / Write / Construct Only
Default value: FALSE