#include <bluedevil/bluedeviladapter.h>

Inheritance diagram for BlueDevil::Adapter:

Public Types
enum	RegisterCapability { DisplayOnly = 0, DisplayYesNo = 1, KeyboardOnly = 2, NoInputNoOutput = 3 }
Public Slots
void	registerAgent (const QString &agentPath, RegisterCapability registerCapability)
void	unregisterAgent (const QString &agentPath)
void	setName (const QString &name)
void	setPowered (bool powered)
void	setDiscoverable (bool discoverable)
void	setPairable (bool pairable)
void	setPaireableTimeout (quint32 paireableTimeout)
void	setDiscoverableTimeout (quint32 discoverableTimeout)
void	removeDevice (Device *device)
void	startDiscovery () const
void	startStableDiscovery () const
void	stopDiscovery () const
Signals
void	deviceFound (Device *device)
void	deviceFound (const QVariantMap &info)
void	deviceDisappeared (Device *device)
void	deviceCreated (Device *device)
void	deviceRemoved (Device *device)
void	pairedDeviceCreated (const QString &path)
void	deviceCreated (const QString &path)
void	nameChanged (const QString &name)
void	poweredChanged (bool powered)
void	discoverableChanged (bool discoverable)
void	pairableChanged (bool pairable)
void	pairableTimeoutChanged (quint32 pairableTimeout)
void	discoverableTimeoutChanged (quint32 discoverableTimeout)
void	devicesChanged (const QList< Device * > &devices)
void	discoveringChanged (bool discovering)
void	propertyChanged (const QString &property, const QVariant &value)
Public Member Functions
virtual	~Adapter ()
QString	address () const
QString	name () const
quint32	adapterClass () const
bool	isPowered () const
bool	isDiscoverable () const
bool	isPairable () const
quint32	paireableTimeout () const
quint32	discoverableTimeout () const
bool	isDiscovering () const
QList< Device * >	foundDevices () const
Device *	deviceForAddress (const QString &address)
Device *	deviceForUBI (const QString &UBI)
QList< Device * >	devices ()
QStringList	UUIDs ()
Properties
QString	address
QString	name
quint32	adapterClass
bool	powered
bool	discoverable
bool	pairable
quint32	paireableTimeout
quint32	discoverableTimeout
bool	isDiscovering
QList< Device * >	foundDevices
QList< Device * >	devices
QStringList	UUIDs
Friends
class	Manager
class	Device

Detailed Description

This class represents an adapter.

The task of an adapter is basically to discover remote devices.

Author:: Rafael Fernández López <ereslibre@kde.org>

Member Enumeration Documentation

enum BlueDevil::Adapter::RegisterCapability

Enumerator:

DisplayOnly
DisplayYesNo
KeyboardOnly
NoInputNoOutput

Constructor & Destructor Documentation

BlueDevil::Adapter::~Adapter ( ) [virtual]

Member Function Documentation

quint32 BlueDevil::Adapter::adapterClass ( ) const

Returns:: The class of the adapter.

QString BlueDevil::Adapter::address ( ) const

Returns:: The address of the adapter.

void BlueDevil::Adapter::deviceCreated ( const QString & path ) [signal]

void BlueDevil::Adapter::deviceCreated ( Device * device ) [signal]

void BlueDevil::Adapter::deviceDisappeared ( Device * device ) [signal]

Device * BlueDevil::Adapter::deviceForAddress ( const QString & address )

Returns:: A device defined by its hardware address.

Device * BlueDevil::Adapter::deviceForUBI ( const QString & UBI )

Returns:: A device defined by its UBI.

void BlueDevil::Adapter::deviceFound ( Device * device ) [signal]

void BlueDevil::Adapter::deviceFound ( const QVariantMap & info ) [signal]

void BlueDevil::Adapter::deviceRemoved ( Device * device ) [signal]

QList<Device*> BlueDevil::Adapter::devices ( )

Returns:: All known devices by this adapter. They haven't been necessarily discovered in this session.

void BlueDevil::Adapter::devicesChanged ( const QList< Device * > & devices ) [signal]

void BlueDevil::Adapter::discoverableChanged ( bool discoverable ) [signal]

quint32 BlueDevil::Adapter::discoverableTimeout ( ) const

Returns:: The timeout for this adapter to be discovered in seconds.

void BlueDevil::Adapter::discoverableTimeoutChanged ( quint32 discoverableTimeout ) [signal]

void BlueDevil::Adapter::discoveringChanged ( bool discovering ) [signal]

QList<Device*> BlueDevil::Adapter::foundDevices ( ) const

Returns:: A list with all found devices on the discovery phase.

bool BlueDevil::Adapter::isDiscoverable ( ) const

Returns:: Whether this adapter is discoverable or not.

bool BlueDevil::Adapter::isDiscovering ( ) const

Returns:: Whether this adapter is discovering at the moment or not.

bool BlueDevil::Adapter::isPairable ( ) const

Returns:: Whether this adapter is pairable or not.

bool BlueDevil::Adapter::isPowered ( ) const

Returns:: Whether this adapter is consuming energy or not.

QString BlueDevil::Adapter::name ( ) const

Returns:: The friendly name of the adapter.

void BlueDevil::Adapter::nameChanged ( const QString & name ) [signal]

void BlueDevil::Adapter::pairableChanged ( bool pairable ) [signal]

void BlueDevil::Adapter::pairableTimeoutChanged ( quint32 pairableTimeout ) [signal]

quint32 BlueDevil::Adapter::paireableTimeout ( ) const

Returns:: The timeout for the pairing process for this adapter in seconds.

void BlueDevil::Adapter::pairedDeviceCreated ( const QString & path ) [signal]

void BlueDevil::Adapter::poweredChanged ( bool powered ) [signal]

void BlueDevil::Adapter::propertyChanged	(	const QString &	property,
		const QVariant &	value
	)		`[signal]`

void BlueDevil::Adapter::registerAgent	(	const QString &	agentPath,
		RegisterCapability	registerCapability
	)		`[slot]`

Registers agent.

void BlueDevil::Adapter::removeDevice ( Device * device ) [slot]

Removes device.

void BlueDevil::Adapter::setDiscoverable ( bool discoverable ) [slot]

Sets whether this adapter is discoverable or not.

void BlueDevil::Adapter::setDiscoverableTimeout ( quint32 discoverableTimeout ) [slot]

Sets the timeout for this adapter to be discovered in seconds.

Note:: A discoverableTimeout of 0 means that this adapter can be discovered forever.

void BlueDevil::Adapter::setName ( const QString & name ) [slot]

Sets the name of this adapter to name.

This is the friendly name of the adapter.

void BlueDevil::Adapter::setPairable ( bool pairable ) [slot]

Sets whether this adapter is pairable or not.

void BlueDevil::Adapter::setPaireableTimeout ( quint32 paireableTimeout ) [slot]

Sets the timeout for the pairing process for this adapter in seconds.

Note:: A paireableTimeout of 0 means that this adapter can be paired forever.

void BlueDevil::Adapter::setPowered ( bool powered ) [slot]

Sets whether this adapter is consuming energy or not.

void BlueDevil::Adapter::startDiscovery ( ) const [slot]

Starts device discovery. deviceFound signal will be emitted for each device found.

Note:: It is possible that when discovering devices appear back and forth. This call will also allow the adapter to signal when devices have disappeared when discovering, what could not be exactly what you want. If the desired behavior is to only be notified of new discovered devices, please see startStableDiscovery.

void BlueDevil::Adapter::startStableDiscovery ( ) const [slot]

Starts device discovery. deviceFound signal will be emitted for each device found.

Note:: This discovery type will never trigger deviceDisappeared signal while discovering, so you will only get deviceFound signals emitted. This also ensures that you will never get deviceFound repeated emissions for the same devices, in this sense is more stable.

void BlueDevil::Adapter::stopDiscovery ( ) const [slot]

Stops device discovery.

void BlueDevil::Adapter::unregisterAgent ( const QString & agentPath ) [slot]

Unregisters agent.

QStringList BlueDevil::Adapter::UUIDs ( )

Returns:: Services provided by this adapter.

Friends And Related Function Documentation

friend class Device [friend]

friend class Manager [friend]

Property Documentation

quint32 BlueDevil::Adapter::adapterClass [read]

QString BlueDevil::Adapter::address [read]

QList< Device * > BlueDevil::Adapter::devices [read]

bool BlueDevil::Adapter::discoverable [read, write]

quint32 BlueDevil::Adapter::discoverableTimeout [read, write]

QList< Device * > BlueDevil::Adapter::foundDevices [read]

bool BlueDevil::Adapter::isDiscovering [read]

QString BlueDevil::Adapter::name [read, write]

bool BlueDevil::Adapter::pairable [read, write]

quint32 BlueDevil::Adapter::paireableTimeout [read, write]

bool BlueDevil::Adapter::powered [read, write]

QStringList BlueDevil::Adapter::UUIDs [read]

BlueDevil::Adapter Class Reference

Public Types

Public Slots

Signals

Public Member Functions