Base class for Connection implementations.
More...
#include <TelepathyQt/BaseConnection>
Inherits Tp::DBusService.
List of all members.
Public Types
Signals
Public Member Functions
- virtual ~BaseConnection ()
- QString cmName () const
- QString protocolName () const
- QVariantMap parameters () const
- QVariantMap immutableProperties () const
- uint selfHandle () const
- void setSelfHandle (uint selfHandle)
- QString selfID () const
- void setSelfID (const QString &selfID)
- void setSelfContact (uint selfHandle, const QString &selfID)
- uint status () const
- void setStatus (uint newStatus, uint reason)
- void setCreateChannelCallback (const CreateChannelCallback &cb)
- BaseChannelPtr createChannel (const QVariantMap &request, bool suppressHandler, DBusError *error)
- void setConnectCallback (const ConnectCallback &cb)
- void setInspectHandlesCallback (const InspectHandlesCallback &cb)
- QStringList inspectHandles (uint handleType, const Tp::UIntList &handles, DBusError *error)
- void setRequestHandlesCallback (const RequestHandlesCallback &cb)
- Tp::UIntList requestHandles (uint handleType, const QStringList &identifiers, DBusError *error)
- Tp::ChannelInfoList channelsInfo ()
- Tp::ChannelDetailsList channelsDetails ()
- BaseChannelPtr ensureChannel (const QVariantMap &request, bool &yours, bool suppressHandler, DBusError *error)
- void addChannel (BaseChannelPtr channel, bool suppressHandler=false)
- QList
< AbstractConnectionInterfacePtr > interfaces () const
- AbstractConnectionInterfacePtr interface (const QString &interfaceName) const
- bool plugInterface (const AbstractConnectionInterfacePtr &interface)
- bool registerObject (DBusError *error=NULL)
- virtual QString uniqueName () const
Static Public Member Functions
Protected Member Functions
Detailed Description
Base class for Connection implementations.
Member Typedef Documentation
Constructor & Destructor Documentation
Tp::BaseConnection::BaseConnection |
( |
const QDBusConnection & |
dbusConnection, |
|
|
const QString & |
cmName, |
|
|
const QString & |
protocolName, |
|
|
const QVariantMap & |
parameters |
|
) |
| [protected] |
Construct a BaseConnection.
- Parameters:
-
dbusConnection | The D-Bus connection that will be used by this object. |
cmName | The name of the connection manager associated with this connection. |
protocolName | The name of the protocol associated with this connection. |
parameters | The parameters of this connection. |
Member Function Documentation
static BaseConnectionPtr Tp::BaseConnection::create |
( |
const QString & |
cmName, |
|
|
const QString & |
protocolName, |
|
|
const QVariantMap & |
parameters, |
|
|
const QDBusConnection & |
dbusConnection = QDBusConnection::sessionBus() |
|
) |
| [inline, static] |
template<typename BaseConnectionSubclass >
static SharedPtr<BaseConnectionSubclass> Tp::BaseConnection::create |
( |
const QString & |
cmName, |
|
|
const QString & |
protocolName, |
|
|
const QVariantMap & |
parameters, |
|
|
const QDBusConnection & |
dbusConnection = QDBusConnection::sessionBus() |
|
) |
| [inline, static] |
Return the name of the connection manager associated with this connection.
- Returns:
- The name of the connection manager associated with this connection.
Return the name of the protocol associated with this connection.
- Returns:
- The name of the protocol associated with this connection.
Return the parameters of this connection.
- Returns:
- The parameters of this connection.
Return the immutable properties of this connection object.
Immutable properties cannot change after the object has been registered on the bus with registerObject().
- Returns:
- The immutable properties of this connection object.
Implements Tp::DBusService.
Return a new or exists channel, satisfying the given request.
This method iterate over exist channels to find the one satisfying the request. If there is no suitable channel, then new channel with given request details will be created. This method uses the matchChannel() method to check whether there exists a channel which confirms with the request.
If error is passed, any error that may occur will be stored there.
- Parameters:
-
request | A dictionary containing the desirable properties. |
yours | A returning argument. true if returned channel is a new one and false otherwise. |
suppressHandler | An option to suppress handler in case of a new channel creation. |
error | A pointer to an empty DBusError where any possible error will be stored. |
- Returns:
- A pointer to a channel, satisfying the given request.
- See also:
- matchChannel()
Return a list of interfaces that have been plugged into this Protocol D-Bus object with plugInterface().
This property is immutable and cannot change after this Protocol object has been registered on the bus with registerObject().
- Returns:
- A list containing all the Protocol interface implementation objects.
- See also:
- plugInterface(), interface()
Return a pointer to the interface with the given name.
- Parameters:
-
interfaceName | The D-Bus name of the interface, ex. TP_QT_IFACE_CONNECTION_INTERFACE_ADDRESSING. |
- Returns:
- A pointer to the AbstractConnectionInterface object that implements the D-Bus interface with the given name, or a null pointer if such an interface has not been plugged into this object.
- See also:
- plugInterface(), interfaces()
Plug a new interface into this Connection D-Bus object.
This property is immutable and cannot change after this Protocol object has been registered on the bus with registerObject().
- Parameters:
-
- Returns:
true
on success or false
otherwise
- See also:
- interfaces(), interface()
Register this connection object on the bus.
If error is passed, any D-Bus error that may occur will be stored there.
- Parameters:
-
error | A 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 object is already registered.
- See also:
- isRegistered()
Return a unique name for this connection.
- Returns:
- A unique name for this connection.
Emitted when this connection has been disconnected.
Check channel on conformity with request.
This virtual method is used to check if a channel satisfying the given request. It is warranted, that the type of the channel meets the requested type.
The default implementation compares TargetHandleType and TargetHandle/TargetID. If error is passed, any error that may occur will be stored there.
- Parameters:
-
channel | A pointer to a channel to be checked. |
request | A dictionary containing the desirable properties. |
error | A pointer to an empty DBusError where any possible error will be stored. |
- Returns:
true
if channel match the request and false
otherwise.
- See also:
- ensureChannel()