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

Base class for connection manager implementations. More...

#include <TelepathyQt/BaseConnectionManager>

Inherits Tp::DBusService.

List of all members.

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Base class for connection manager implementations.


Constructor & Destructor Documentation

Class destructor.

Tp::BaseConnectionManager::BaseConnectionManager ( const QDBusConnection &  dbusConnection,
const QString &  name 
) [protected]

Constructs a new BaseConnectionManager object that implements a connection manager on the given dbusConnection and has the given name.

Parameters:
dbusConnectionThe QDBusConnection to use.
nameThe name of the connection manager.

Member Function Documentation

static BaseConnectionManagerPtr Tp::BaseConnectionManager::create ( const QString &  name) [inline, static]
template<typename BaseConnectionManagerSubclass >
static SharedPtr<BaseConnectionManagerSubclass> Tp::BaseConnectionManager::create ( const QString &  name) [inline, static]
static BaseConnectionManagerPtr Tp::BaseConnectionManager::create ( const QDBusConnection &  dbusConnection,
const QString &  name 
) [inline, static]
template<typename BaseConnectionManagerSubclass >
static SharedPtr<BaseConnectionManagerSubclass> Tp::BaseConnectionManager::create ( const QDBusConnection &  dbusConnection,
const QString &  name 
) [inline, static]

Return the connection manager's name, as given on the constructor.

Returns:
The connection manager's name.
QVariantMap Tp::BaseConnectionManager::immutableProperties ( ) const [virtual]

Return the immutable properties of this connection manager object.

Immutable properties cannot change after the object has been registered on the bus with registerObject().

Returns:
The immutable properties of this connection manager object.

Implements Tp::DBusService.

QList< BaseProtocolPtr > Tp::BaseConnectionManager::protocols ( ) const

Return a list of all protocols that this connection manager implements.

This property is immutable and cannot change after the connection manager has been registered on the bus with registerObject().

Returns:
A list of all protocols that this connection manager implements.
See also:
addProtocol(), hasProtocol(), protocol()
BaseProtocolPtr Tp::BaseConnectionManager::protocol ( const QString &  protocolName) const

Return a pointer to the BaseProtocol instance that implements the protocol with the given protocolName, or a null BaseProtocolPtr if no such protocol has been added to the connection manager.

Parameters:
protocolNameThe name of the protocol in interest.
Returns:
The BaseProtocol instance that implements the protocol with the given protocolName.
See also:
hasProtocol(), protocols(), addProtocol()
bool Tp::BaseConnectionManager::hasProtocol ( const QString &  protocolName) const

Return whether a protocol with the given protocolName has been added to the connection manager.

Parameters:
protocolNameThe name of the protocol in interest.
Returns:
true if a protocol with the given protocolName has been added to the connection manager, or false otherwise.
See also:
addProtocol(), protocol(), protocols()
bool Tp::BaseConnectionManager::addProtocol ( const BaseProtocolPtr &  protocol)

Add a new protocol to the list of protocols that this connection manager implements.

Note that you cannot add new protocols after the connection manager has been registered on the bus with registerObject(). In addition, you cannot add two protocols with the same name. If any of these conditions is not met, this function will return false and print a suitable warning.

Parameters:
protocolThe protocol to add.
Returns:
true on success or false otherwise.

Register this connection manager on the bus.

A connection manager can only be registered once, and it should be registered only after all the protocols it implements have been added with addProtocol().

If error is passed, any D-Bus error that may occur will be stored there.

Parameters:
errorA pointer to an empty DBusError where any possible D-Bus error will be stored.
Returns:
true on success and false if there was an error or this connection manager is already registered.
See also:
isRegistered()
QList< BaseConnectionPtr > Tp::BaseConnectionManager::connections ( ) const

Return a list of all connections that have currently been made.

Returns:
A list of all connections that have currently been made.
void Tp::BaseConnectionManager::newConnection ( const BaseConnectionPtr &  connection) [signal]
bool Tp::BaseConnectionManager::registerObject ( const QString &  busName,
const QString &  objectPath,
DBusError error 
) [protected, virtual]

Reimplemented from DBusService.

Reimplemented from Tp::DBusService.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.3