Collapse all Symbian^3 Product Developer Library

CSdpAgent Class Reference

class CSdpAgent : public CBase

Makes Bluetooth service discovery protocol (SDP) requests to a remote device.

To make SDP requests,

Construct a CSdpAgent object with the Bluetooth address of the remote device to query.

Set the classes of service that you want to query for. The classes have predefined UUIDs, which you specify with SetRecordFilterL().

Get results through NextRecordRequestL(). Information on services is stored as records, which can be queried in turn for attribute values for the service through AttributeRequestL().

A user of this class must implement MSdpAgentNotifier to receive the responses to queries.

Note that queries are asynchronous, although this is hidden in the API. The implication is that the interface functions that receive responses are only called when the thread's active scheduler can schedule handling of the completion of the query.

MSdpAgentNotifier

Inherits from

CSdpAgent
- CBase

Public Member Functions
	~CSdpAgent()
IMPORT_C void	AttributeRequestL(TSdpServRecordHandle, TSdpAttributeID)
IMPORT_C void	AttributeRequestL(TSdpServRecordHandle, const CSdpAttrIdMatchList &)
IMPORT_C void	AttributeRequestL(MSdpElementBuilder *, TSdpServRecordHandle, TSdpAttributeID)
IMPORT_C void	AttributeRequestL(MSdpElementBuilder *, TSdpServRecordHandle, const CSdpAttrIdMatchList &)
IMPORT_C void	Cancel()
IMPORT_C CSdpAgent *	NewL(MSdpAgentNotifier &, const TBTDevAddr &)
IMPORT_C CSdpAgent *	NewLC(MSdpAgentNotifier &, const TBTDevAddr &)
IMPORT_C void	NextRecordRequestL()
IMPORT_C void	SetAttributePredictorListL(const CSdpAttrIdMatchList &)
IMPORT_C void	SetRecordFilterL(const CSdpSearchPattern &)

Private Member Functions
	CSdpAgent()
void	ConstructL(MSdpAgentNotifier &, TBTDevAddr)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CSdpAgentEng *	iAgentEngine

Constructor & Destructor Documentation

CSdpAgent()

CSdpAgent

(

)

[private]

~CSdpAgent()

IMPORT_C

~CSdpAgent

(

)

Destructor.

Member Functions Documentation

AttributeRequestL(TSdpServRecordHandle, TSdpAttributeID)

IMPORT_C void	AttributeRequestL	(	TSdpServRecordHandle	aHandle,
			TSdpAttributeID	aAttrID
		)

Gets the specified attribute for a remote service.

The function is asynchronous: on completion, it calls MSdpAgentNotifier::AttributeRequestComplete().

If the attribute is found, the function passes it by also calling MSdpAgentNotifier::AttributeRequestResult().

MSdpAgentNotifier::AttributeRequestComplete() MSdpAgentNotifier::AttributeRequestResult()

capability: LocalServices

Parameters

TSdpServRecordHandle aHandle	The service for which to get the attribute, specified by its record handle
TSdpAttributeID aAttrID	The ID of the attribute to get

AttributeRequestL(TSdpServRecordHandle, const CSdpAttrIdMatchList &)

IMPORT_C void	AttributeRequestL	(	TSdpServRecordHandle	aHandle,
			const CSdpAttrIdMatchList &	aMatchList
		)

Gets the specified attributes for a remote service.

The function is asynchronous: on completion, it calls MSdpAgentNotifier::AttributeRequestComplete().

The function also calls MSdpAgentNotifier::AttributeRequestResult() for each attribute found.

MSdpAgentNotifier::AttributeRequestComplete() MSdpAgentNotifier::AttributeRequestResult()

capability: LocalServices

Parameters

TSdpServRecordHandle aHandle	The service for which to get the attribute, specified by its record handle
const CSdpAttrIdMatchList & aMatchList	A list of attributes to get

AttributeRequestL(MSdpElementBuilder *, TSdpServRecordHandle, TSdpAttributeID)

IMPORT_C void	AttributeRequestL	(	MSdpElementBuilder *	aBuilder,
			TSdpServRecordHandle	aHandle,
			TSdpAttributeID	aAttrID
		)

Gets the specified attribute for a remote service.

The function is asynchronous: on completion, it calls MSdpAgentNotifier::AttributeRequestComplete().

If the attribute is found, the function calls aBuilder's interface to set the attribute ID and value.

MSdpAgentNotifier::AttributeRequestComplete()

capability: LocalServices

Parameters

MSdpElementBuilder * aBuilder	Object implementing the MSdpElementBuilder interface. It will be called with each type found in the response.
TSdpServRecordHandle aHandle	The service for which to get the attribute, specified by its record handle
TSdpAttributeID aAttrID	The ID of the attribute to get

AttributeRequestL(MSdpElementBuilder *, TSdpServRecordHandle, const CSdpAttrIdMatchList &)

IMPORT_C void	AttributeRequestL	(	MSdpElementBuilder *	aBuilder,
			TSdpServRecordHandle	aHandle,
			const CSdpAttrIdMatchList &	aMatchList
		)

Gets the specified attributes for a remote service.

The function is asynchronous: on completion, it calls MSdpAgentNotifier::AttributeRequestComplete().

As each attribute is found, the function calls aBuilder's interface to set the attribute ID and value.

MSdpAgentNotifier::AttributeRequestComplete()

capability: LocalServices

Parameters

MSdpElementBuilder * aBuilder	Object implementing the MSdpElementBuilder interface. It will be called with each type found in the response.
TSdpServRecordHandle aHandle	The service for which to get the attribute, specified by its record handle
const CSdpAttrIdMatchList & aMatchList	A list of attributes to get

Cancel()

IMPORT_C void

Cancel

(

)

Attempts to cancel an SDP Agent request.

Calls cancel on active objects making request. Resets all variables associated with a request and its state.

NB The cancel operation will not, and cannot stop results from an SDP query being sent by the remote.

capability: LocalServices

ConstructL(MSdpAgentNotifier &, TBTDevAddr)

void	ConstructL	(	MSdpAgentNotifier &	aNotifier,
			TBTDevAddr	aDevAddr
		)	[private]

Parameters

MSdpAgentNotifier & aNotifier
TBTDevAddr aDevAddr

NewL(MSdpAgentNotifier &, const TBTDevAddr &)

IMPORT_C CSdpAgent *	NewL	(	MSdpAgentNotifier &	aNotifier,
			const TBTDevAddr &	aDevAddr
		)	[static]

Creates a new SDP Agent object.

capability: LocalServices

Parameters

MSdpAgentNotifier & aNotifier	Interface implemented by the query requester, which the agent calls asynchronously to pass responses to queries
const TBTDevAddr & aDevAddr	The Bluetooth address of the remote device to query

NewLC(MSdpAgentNotifier &, const TBTDevAddr &)

IMPORT_C CSdpAgent *	NewLC	(	MSdpAgentNotifier &	aNotifier,
			const TBTDevAddr &	aDevAddr
		)	[static]

Creates a new SDP Agent object.

Allocate and construct a service discovery agent, leaving the object on the cleanup stack.

capability: LocalServices

Parameters

MSdpAgentNotifier & aNotifier	Interface implemented by the query requester, which the agent calls asynchronously to pass responses to queries
const TBTDevAddr & aDevAddr	The Bluetooth address of the remote device to query

NextRecordRequestL()

IMPORT_C void

NextRecordRequestL

(

)

Gets a handle to the record for the next (or first) service on the remote device that matches the service class filter previously set.

The function is asynchronous: on completion, it calls NextRecordRequestComplete() on the MSdpAgentNotifier interface passed in the NewL().

MSdpAgentNotifier::NextRecordRequestComplete()

capability: LocalServices

SetAttributePredictorListL(const CSdpAttrIdMatchList &)

IMPORT_C void

SetAttributePredictorListL

(

const CSdpAttrIdMatchList &

aMatchList

)

This does nothing! (It used to create a copy of an attribute match list supplied, and place it in the CSdpAgentEng object.)

capability: LocalServices

Parameters

const CSdpAttrIdMatchList & aMatchList

Attribute - now unused

SetRecordFilterL(const CSdpSearchPattern &)

IMPORT_C void

SetRecordFilterL

(

const CSdpSearchPattern &

aUUIDFilter

)

Sets the classes of service to query for on the remote device.

Responses from the agent will only contain records for services that belong to the classes listed in aUUIDFilter. Service classes are represented as unique identifiers (UUIDs).

capability: LocalServices

Parameters

const CSdpSearchPattern & aUUIDFilter

A list of UUIDs that will be matched in SDP Service Search Requests. The function takes a copy of the object. Any previous UUID list is deleted.

Member Data Documentation

CSdpAgentEng * iAgentEngine

CSdpAgentEng *

iAgentEngine

[private]