CBluetoothPhysicalLinks Class Reference

#include <bt_sock.h>

class CBluetoothPhysicalLinks : public CBase

Inherits from

CBluetoothPhysicalLinks

Public Member Functions
	~CBluetoothPhysicalLinks()
RBTBaseband &	BTBaseband()
IMPORT_C TInt	Broadcast(const TDesC8 &)
IMPORT_C void	CancelCreateConnection()
IMPORT_C TInt	CreateConnection(const TBTDevAddr &)
IMPORT_C TInt	Disconnect(const TBTDevAddr &)
IMPORT_C TInt	DisconnectAll()
IMPORT_C TInt	DisconnectAllForPowerOff()
IMPORT_C TInt	Enumerate(RBTDevAddrArray &, TUint)
void	HandleCreateConnectionCompleteL(TInt)
void	HandleDisconnectAllCompleteL(TInt)
void	HandleDisconnectCompleteL(TInt)
IMPORT_C CBluetoothPhysicalLinks *	NewL(MBluetoothPhysicalLinksNotifier &, RSocketServ &)
IMPORT_C CBluetoothPhysicalLinks *	NewLC(MBluetoothPhysicalLinksNotifier &, RSocketServ &)
MBluetoothPhysicalLinksNotifier &	Notifier()
IMPORT_C TInt	ReadRaw(TDes8 &)
RSocketServ &	SockServer()

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()

Detailed Description

This is used to enumerate members of piconet, and attach and remove members thereof

It may also be used for non-service dependent reads and writes.

Constructor & Destructor Documentation

~CBluetoothPhysicalLinks ( )

IMPORT_C

~CBluetoothPhysicalLinks

(

)

Destructor

Member Function Documentation

BTBaseband ( )

RBTBaseband &

BTBaseband

(

)

This method is for internal sub-system use only and should be not be used otherwise.

Broadcast ( const TDesC8 & )

IMPORT_C TInt

Broadcast

(

const TDesC8 &

aData

)

Write (raw) broadcast data

Raw broadcast data is data that is not directed to any specified service. Test

capability: NetworkControl

Parameter	Description
aData	Contains data to be broadcast.

Returns: Error code

CancelCreateConnection ( )

IMPORT_C void

CancelCreateConnection

(

)

Cancel bringing in a new member to the piconet

CreateConnection ( const TBTDevAddr & )

IMPORT_C TInt

CreateConnection

(

const TBTDevAddr &

aDevAddr

)

Bring in a new member to the piconet

This can be useful for preparing for a logical link (service socket). Firstly if the local device has not bonded with the specified remote device, then this function can be used to allow the bonding procedure can take place in advance. Secondly if a CBluetoothSocket call is made to create a logical link within an internally specified time of this CreateConnection function being called, then that link will come up much faster since the physical link will already be in place. Unless this connection is taken up by a logical link (or a synchronous link) within that internally specified time then it will be closed.

This function can also be used to create a physical link ready for the setting up of a synchronous link (e.g. voice link).

Parameter	Description
aDevAddr	Bluetooth address specifying remote device (new member of piconet)

Returns: Error code

Disconnect ( const TBTDevAddr & )

IMPORT_C TInt

Disconnect

(

const TBTDevAddr &

aDevAddr

)

Disconnect a single member of piconet

capability: NetworkControl

Parameter	Description
aDevAddr	Bluetooth address specifying remote device (member of piconet)

Returns: Error code

DisconnectAll ( )

IMPORT_C TInt

DisconnectAll

(

)

Disconnect all members of piconet with the reason code "Remote User Terminated Connection"

capability: NetworkControl

Returns: Error code

DisconnectAllForPowerOff ( )

IMPORT_C TInt

DisconnectAllForPowerOff

(

)

Disconnect all members of piconet with the reason code "Remote Device Terminated Connection due to Power Off"

capability: NetworkControl

Returns: Error code

Enumerate ( RBTDevAddrArray &, TUint )

IMPORT_C TInt	Enumerate	(	RBTDevAddrArray &	aBTDevAddrArray,
			TUint	aMaxNumber
		)

Enumerate connected members of the piconet

Parameter	Description
aBTDevAddrArray	Bluetooth device address array to be filled with bluetooth addresses of connected members of the piconet.
aMaxNumber	Upper limit on number of members to be returned.

Returns: Error code

HandleCreateConnectionCompleteL ( TInt )

void

HandleCreateConnectionCompleteL

(

TInt

aErr

)

This method is for internal sub-system use only and should be not be used otherwise.

HandleDisconnectAllCompleteL ( TInt )

void

HandleDisconnectAllCompleteL

(

TInt

aErr

)

This method is for internal sub-system use only and should be not be used otherwise.

HandleDisconnectCompleteL ( TInt )

void

HandleDisconnectCompleteL

(

TInt

aErr

)

This method is for internal sub-system use only and should be not be used otherwise.

NewL ( MBluetoothPhysicalLinksNotifier &, RSocketServ & )

IMPORT_C CBluetoothPhysicalLinks *	NewL	(	MBluetoothPhysicalLinksNotifier &	aNotifier,
			RSocketServ &	aServer
		)	[static]

Constructor

Opens a Bluetooth socket.

Pre-condition: A session on the socket server has been started.

leave: No memory, or error on opening socket

Parameter	Description
aNotifier	The object which will receive asynchronous events.
aServer	The socket server.

Returns: An object of type CBluetoothPhysicalLinks

NewLC ( MBluetoothPhysicalLinksNotifier &, RSocketServ & )

IMPORT_C CBluetoothPhysicalLinks *	NewLC	(	MBluetoothPhysicalLinksNotifier &	aNotifier,
			RSocketServ &	aServer
		)	[static]

Constructor

Opens a Bluetooth socket.

Pre-condition: A session on the socket server has been started.

leave: No memory, or error on opening socket

Parameter	Description
aNotifier	The object which will receive asynchronous events.
aServer	The socket server.

Returns: An object of type CBluetoothPhysicalLinks

Notifier ( )

MBluetoothPhysicalLinksNotifier &

Notifier

(

)

This method is for internal sub-system use only and should be not be used otherwise.

ReadRaw ( TDes8 & )

IMPORT_C TInt

ReadRaw

(

TDes8 &

aData

)

Receive (raw) broadcast data

Raw broadcast data is data that is not directed to any specified service. Test

capability: NetworkControl

Parameter	Description
aData	Contains data received.

Returns: Error code

SockServer ( )

RSocketServ &

SockServer

(

)

This method is for internal sub-system use only and should be not be used otherwise.