Home · All Classes · All Namespaces · Modules · Functions · Files
Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
Tp::TubeChannel Class Reference

This is the base class for all tube types. More...

#include <TelepathyQt4/TubeChannel>

Inherits Tp::Channel.

Inherited by Tp::StreamTubeChannel.

List of all members.

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions


Detailed Description

This is the base class for all tube types.

A tube is a mechanism for arbitrary data transfer between two or more IM users, used to allow applications on the users' systems to communicate without having to establish network connections themselves.

Note:
You should never create an abstract tube: you should use one of its subclasses instead. At the moment, StreamTube and DBusTube are available.

For more details, please refer to Telepathy specification.


Constructor & Destructor Documentation

Tp::TubeChannel::~TubeChannel ( ) [virtual]

Class destructor.

Tp::TubeChannel::TubeChannel ( const ConnectionPtr &  connection,
const QString objectPath,
const QVariantMap &  immutableProperties,
const Feature coreFeature = TubeChannel::FeatureCore 
) [protected]

Construct a new TubeChannel object.

Parameters:
connectionConnection owning this channel, and specifying the service.
objectPathThe object path of this channel.
immutablePropertiesThe immutable properties of this channel.

Member Function Documentation

TubeChannelPtr Tp::TubeChannel::create ( const ConnectionPtr &  connection,
const QString objectPath,
const QVariantMap &  immutableProperties 
) [static]

Create a new TubeChannel channel.

Parameters:
connectionConnection owning this channel, and specifying the service.
objectPathThe object path of this channel.
immutablePropertiesThe immutable properties of this channel.
Returns:
A TubeChannelPtr object pointing to the newly created TubeChannel object.

Reimplemented from Tp::Channel.

Reimplemented in Tp::IncomingStreamTubeChannel, Tp::OutgoingStreamTubeChannel, and Tp::StreamTubeChannel.

TubeChannelState Tp::TubeChannel::tubeState ( ) const

This methods returns the state of the tube in this channel. It can be used to find out whether the tube is already opened.

Returns:
The State of the tube in this channel.
Note:
This method requires TubeChannel::FeatureTube to be enabled.
QVariantMap Tp::TubeChannel::parameters ( ) const

Returns the parameters associated with this tube, if any.

This method requires TubeChannel::FeatureTube to be enabled.

Returns:
A dictionary of arbitrary parameters. Please refer to the spec for more details.
Note:
For outgoing tubes, this function will return a valid value only after the tube has been offered successfully.
void Tp::TubeChannel::tubeStateChanged ( Tp::TubeChannelState  state) [signal]

Emitted when the state of the tube has changed, if FeatureTube has been enabled.

void Tp::TubeChannel::setParameters ( const QVariantMap &  parameters) [protected]

Member Data Documentation

Feature representing the core that needs to become ready to make the TubeChannel object usable.

Note that this feature must be enabled in order to use most TubeChannel methods. See specific methods documentation for more details.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.7.1