IceBT::Plugin Class Reference

Represents the IceBT plug-in object. More...

#include <IceBT/IceBT.h>

Inheritance diagram for IceBT::Plugin:

Collaboration diagram for IceBT::Plugin:

Public Member Functions
virtual DeviceMap	getDevices () const =0
	Retrieve a snapshot of all known remote devices.
virtual void	startDiscovery (const std::string &address, const DiscoveryCallbackPtr &cb)=0
	Start Bluetooth device discovery on the adapter with the specified address.
virtual void	stopDiscovery (const std::string &address)=0
	Stops Bluetooth device discovery on the adapter with the specified address.
Public Member Functions inherited from Ice::Plugin
virtual void	destroy ()=0
	Called when the communicator is being destroyed.
virtual void	initialize ()=0
	Perform any necessary initialization steps.
virtual	~Plugin ()
Public Member Functions inherited from Ice::LocalObject
virtual bool	operator< (const LocalObject &) const
virtual bool	operator== (const LocalObject &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Additional Inherited Members
Public Types inherited from Ice::Plugin
typedef PluginPtr	PointerType
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

Represents the IceBT plug-in object.

Member Function Documentation

getDevices()

virtual DeviceMap IceBT::Plugin::getDevices ( ) const

pure virtual

Retrieve a snapshot of all known remote devices.

The plug-in obtains a snapshot of the remote devices at startup and then dynamically updates its map as the host adds and removes devices.

Returns

A map containing properties for each known device.

startDiscovery()

virtual void IceBT::Plugin::startDiscovery ( const std::string & address, const DiscoveryCallbackPtr & cb )

pure virtual

Start Bluetooth device discovery on the adapter with the specified address.

The given callback will be invoked for each discovered device. The same device may be reported more than once. Discovery remains active until explicitly stopped by a call to stopDiscovery(), or via other administrative means.

Parameters

address	The address associated with the Bluetooth adapter.
cb	The callback to invoke when a device is discovered.

stopDiscovery()

virtual void IceBT::Plugin::stopDiscovery ( const std::string & address )

pure virtual

Stops Bluetooth device discovery on the adapter with the specified address.

All discovery callbacks are removed when discovery stops.

Parameters

address

The address associated with the Bluetooth adapter.

---

The documentation for this class was generated from the following file:

• IceBT/Plugin.h