Collapse all Symbian^3 Application Developer Library

MPhysicalLinksState Class Reference

class MPhysicalLinksState

An implementation of this interface would present a snapshot of the current Physical, Asynchronous and Synchronous links associated with a Bluetooth device.

It also provides information appertaining to a remote device at the other end of a physical link.

It should be noted that the returned data are a snapshot of the current links associated with a Bluetooth device. They may become stale very quickly.

Mixin class to be used as an interface to the stack.

Public Member Functions
TInt	MplsGetBasebandLinkState ( TBTBasebandLinkState &, const TBTDevAddr &)
TInt	MplsGetConnectionHandles ( RHCIConnHandleArray &, TLinkType )
TInt	MplsGetConnectionHandles ( RHCIConnHandleArray &, TLinkType , const TBTDevAddr &)
TInt	MplsGetLinkPolicySettings ( TLinkPolicy &, const TBTDevAddr &)
TInt	MplsGetNumPendingHandles ( TInt &, TLinkType )
TInt	MplsGetNumPendingHandles ( TInt &, TLinkType , const TBTDevAddr &)
TInt	MplsGetRemoteAddress ( TBTDevAddr &, THCIConnHandle )
TInt	MplsGetRemoteDeviceClass ( TBTDeviceClass &, const TBTDevAddr &)
TInt	MplsGetRemoteSupportedFeatures ( TBTFeatures &, const TBTDevAddr &)

Member Functions Documentation

MplsGetBasebandLinkState(TBTBasebandLinkState &, const TBTDevAddr &)

TInt	MplsGetBasebandLinkState	(	TBTBasebandLinkState &	aBasebandLinkState,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns the link state for the device specified by the Bluetooth device address. The state indicates whether the link is up, down or pending. If the link is up, the following information may be determined: the role (master or slave), power mode (link mode, e.g Sniff Mode), max slots (currently 1, 3 or 5), whether the link is encrypted, and whether the link is authenticated.

TBTBasebandLinkState

Parameters

TBTBasebandLinkState & aBasebandLinkState	A client supplied variable that, on successful completion of this operation, will be populated with the required Bluetooth link state.
const TBTDevAddr & aBDAddr	A client supplied Bluetooth device address for which the device class is required.

MplsGetConnectionHandles(RHCIConnHandleArray &, TLinkType)

TInt	MplsGetConnectionHandles	(	RHCIConnHandleArray &	aConnectionHandles,
			TLinkType	aLinkType
		)	const [pure virtual]

Returns a list of 'connected' connection handles for all links of the specified type. Pending connection handles are not returned by this method.

The returned data are a snapshot and will grow stale. They should therefore be used immediately (in the same call stack) or not at all. It would be wise to check whether the returned links are still connected.

TInt BasebandLinkState( TBTBasebandLinkState & aBasebandLinkState, const TBTDevAddr & aBDAddr);

Parameters

RHCIConnHandleArray & aConnectionHandles	A client supplied dynamic array that, on successful completion of this operation, will be populated with the requested connection handles.
TLinkType aLinkType	Indicates the type of link handles to be returned.

MplsGetConnectionHandles(RHCIConnHandleArray &, TLinkType, const TBTDevAddr &)

TInt	MplsGetConnectionHandles	(	RHCIConnHandleArray &	aConnectionHandles,
			TLinkType	aLinkType,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns a list of 'connected' connection handles for all links of the specified type and Bluetooth device address. Pending connection handles are not returned by this method.

Parameters

RHCIConnHandleArray & aConnectionHandles	A client supplied dynamic array that, on successful completion of this operation, will be populated with the requested connection handles.
TLinkType aLinkType	Indicates the type of link handles to be returned.
const TBTDevAddr & aBDAddr	The client supplied Bluetooth device address of the remote device for which the list of links is required.

MplsGetLinkPolicySettings(TLinkPolicy &, const TBTDevAddr &)

TInt	MplsGetLinkPolicySettings	(	TLinkPolicy &	aLinkPolicySettings,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns the link policy settings for the physical link with the remote device specified by the Bluetooth device address parameter

Parameters

TLinkPolicy & aLinkPolicySettings	A client supplied variable that, on successful completion of this operation, will be populated with the required Bluetooth link policy settings
const TBTDevAddr & aBDAddr	A client supplied Bluetooth device address for which the device class is required.

MplsGetNumPendingHandles(TInt &, TLinkType)

TInt	MplsGetNumPendingHandles	(	TInt &	aConnectionHandles,
			TLinkType	aLinkType
		)	const [pure virtual]

Returns the number of 'pending' connection handles for all links of the specified type.

The returned data are a snapshot and will grow stale. They should therefore be used immediately (in the same call stack) or not at all.

Parameters

TInt & aConnectionHandles	A client supplied TInt that, on successful completion of this operation, will be contain the number of pending connection handles.
TLinkType aLinkType	Indicates the type of link handles to be returned.

MplsGetNumPendingHandles(TInt &, TLinkType, const TBTDevAddr &)

TInt	MplsGetNumPendingHandles	(	TInt &	aConnectionHandles,
			TLinkType	aLinkType,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns the number of 'pending' connection handles for all links of the specified type and Bluetooth device address.

The returned data are a snapshot and will grow stale. They should therefore be used immediately (in the same call stack) or not at all.

Parameters

TInt & aConnectionHandles	A client supplied TInt that, on successful completion of this operation, will contain the number of pending connection handles..
TLinkType aLinkType	Indicates the type of link handles to be returned.
const TBTDevAddr & aBDAddr	The client supplied Bluetooth device address of the remote device for which the number of pending links is required.

MplsGetRemoteAddress(TBTDevAddr &, THCIConnHandle)

TInt	MplsGetRemoteAddress	(	TBTDevAddr &	aBDAddr,
			THCIConnHandle	aConnectionHandle
		)	const [pure virtual]

Returns the Bluetooth device address associated with the supplied connection handle.

Parameters

TBTDevAddr & aBDAddr	A client supplied variable that, on successful completion of this operation, will be populated with the required Bluetooth device address.
THCIConnHandle aConnectionHandle	A client supplied connection handle for which the device address is required.

MplsGetRemoteDeviceClass(TBTDeviceClass &, const TBTDevAddr &)

TInt	MplsGetRemoteDeviceClass	(	TBTDeviceClass &	aDeviceClass,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns the remote device's class for the device specified by the Bluetooth device address.

Parameters

TBTDeviceClass & aDeviceClass	A client supplied variable that, on successful completion of this operation, will be populated with the required Bluetooth device class.
const TBTDevAddr & aBDAddr	A client supplied Bluetooth device address for which the device class is required.

MplsGetRemoteSupportedFeatures(TBTFeatures &, const TBTDevAddr &)

TInt	MplsGetRemoteSupportedFeatures	(	TBTFeatures &	aRemoteSupportedFeatures,
			const TBTDevAddr &	aBDAddr
		)	const [pure virtual]

Returns the Bluetooth capabilities of the remote device specified by the Bluetooth device address.

Parameters

TBTFeatures & aRemoteSupportedFeatures	A client supplied variable that, on successful completion of this operation, will be populated with the required Bluetooth remote supported features.
const TBTDevAddr & aBDAddr	A client supplied Bluetooth device address for which the device class is required.