Class CBluetoothSocket

class CBluetoothSocket : public CBase;

Description

This allows Bluetooth ACL socket-based services to be run.

It allows all user-plane data flow to occur, plus control-plane Bluetooth baseband modification capabilities.

For a more detailed description of RBTBaseband functionality see the class and function documentation for RBTPhysicalLinkAdapter.

This class doesn't provide the functionality to directly activate Active mode (this is implementated in class RBTPhysicalLinkAdapter.)

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CBluetoothSocket - This allows Bluetooth ACL socket-based services to be run.

Members

Defined in CBluetoothSocket:

• Accept(CBluetoothSocket &)Accepts a connection from a remote Bluetooth socket.
• Accept(CBluetoothSocket &,TDes8 &)Reserved for future.
• ActivateBasebandEventNotifier(TUint32)Set up notification of baseband events
• ActivateParkRequester()Activate park requestor.
• ActivateSniffRequester()
• AllowLowPowerModes(TUint32)Allow low power modes.
• AllowRoleSwitch()Allow the socket to switch roles.
• AsyncDelete()Asynchronous deletion of the CBluetoothSocket object.
• AutomaticSniffMode()constReports the automatic sniff/unsniff requesting status of the socket.
• Bind(TSockAddr &)Sets a Bluetooth socket address.
• CancelAccept()Cancels the CBluetoothSocket::Accept(CBluetoothSocket &) operation.
• CancelAll()Cancels all outstanding operations.
• CancelBasebandEventNotifier()Cancels an active baseband notifier.
• CancelConnect()Cancel an attempted connection.
• CancelIoctl()Cancels the CBluetoothSocket::Ioctl(TUint,TUint,TDes8 *) asynchronous control op...
• CancelLowPowerModeRequester()Cancels the low power mode request.
• CancelRead()Cancels an outstanding CBluetoothSocket::Read(TDes8 &) operation.
• CancelRecv()Cancels an outstanding CBluetoothSocket::Recv(TDes8 &,TUint) operation.
• CancelSend()Cancels an outstanding Bluetooth CBluetoothSocket::Send(const TDesC8 &,TUint...
• CancelWrite()Cancels an outstanding CBluetoothSocket::Write(const TDesC8 &) operation.
• Connect(TBTSockAddr &)Opens a connection to a specific Bluetooth device by its address.
• Connect(TBTSockAddr &,TUint16)Sets the Service bits in the Class Of Device. If this is successful, the socket ...
• Connect(TBTSockAddr &,const TDesC8 &,TDes8 &)Connects to a remote Bluetooth device by address with a defined data-out and dat...
• GetDisconnectData(TDes8 &)
• GetOpt(TUint,TUint,TDes8 &)Gets a socket option.
• GetOpt(TUint,TUint,TInt &)Gets a socket option.
• Info(TProtocolDesc &)Gets information about the protocol the socket is opened on.
• Ioctl(TUint,TDes8 *,TUint)
• Ioctl(TUint,TUint,TDes8 *)Applies an asynchronous control operation on a socket.
• Listen(TUint)Sets up a socket to listen for incoming connections.
• Listen(TUint,TUint16)Sets the Service bits in the Class Of Device. If this is successful, the socket ...
• Listen(TUint,const TDesC8 &)Reserved for future.
• LocalName(TSockAddr &)Gets the local address of a socket.
• LocalPort()Gets the local port of a socket.
• Name(TName &)Used to get a unique name of a socket.
• NewL(MBluetoothSocketNotifier &,RSocketServ &)Bluetooth blank socket CBluetoothSocket::NewL(MBluetoothSocketNotifier &,RSo...
• NewL(MBluetoothSocketNotifier &,RSocketServ &,RSocket &)Bluetooth socket using an existing RSocket instance constructor.
• NewL(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint)Standard Bluetooth socket NewL constructor.
• NewL(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint,RConnection &)Opens a Bluetooth socket on a specified connection.
• NewL(MBluetoothSocketNotifier &,RSocketServ &,const TDesC &)Bluetooth socket named protocol CBluetoothSocket::NewL(MBluetoothSocketNotifier ...
• NewLC(MBluetoothSocketNotifier &,RSocketServ &)Bluetooth blank socket CBluetoothSocket::NewLC(MBluetoothSocketNotifier &,RS...
• NewLC(MBluetoothSocketNotifier &,RSocketServ &,RSocket &)Bluetooth socket using an existing RSocket instance constructor.
• NewLC(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint)Standard Bluetooth socket NewLC constructor.
• NewLC(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint,RConnection &)This constructor opens a Bluetooth socket on a specified connection.
• NewLC(MBluetoothSocketNotifier &,RSocketServ &,const TDesC &)Bluetooth socket named protocol CBluetoothSocket::NewLC(MBluetoothSocketNotifier...
• PhysicalLinkState(TUint32 &)Get the state of the physical link.
• PreventLowPowerModes(TUint32)Prevents low power modes from being activated.
• PreventRoleSwitch()Role switching is not allowed.
• Read(TDes8 &)Receives data from a remote Bluetooth host.
• Recv(TDes8 &,TUint)Receives data from a remote Bluetooth device.
• Recv(TDes8 &,TUint,TSockXfrLength &)Receives data from a remote Bluetooth device.
• RecvFrom(TDes8 &,TSockAddr &,TUint)Receives aDesc data from the named remote aAddr Bluetooth device using the flags...
• RecvFrom(TDes8 &,TSockAddr &,TUint,TSockXfrLength &)Receives aDesc data from the named remote aAddr Bluetooth device using the flags...
• RecvOneOrMore(TDes8 &,TUint,TSockXfrLength &)Receives data from a remote Bluetooth device, completing when data is available.
• RemoteName(TSockAddr &)Gets the remote address of a socket.
• RequestChangeSupportedPacketTypes(TUint16)Request to change the supported packet types.
• RequestMasterRole()Request the socket take on the master role.
• RequestSlaveRole()Request the socket take on a slave role.
• Send(const TDesC8 &,TUint)Sends data to a remote bluetooth device.
• Send(const TDesC8 &,TUint,TSockXfrLength &)Sends data to a remote bluetooth device.
• SendTo(const TDesC8 &,TSockAddr &,TUint)Sends the aDesc data to the aAddr specified and applies the flags indicated to t...
• SendTo(const TDesC8 &,TSockAddr &,TUint,TSockXfrLength &)Sends the aDesc data to the aAddr specified and applies the flags indicated to t...
• SetAutomaticSniffMode(TBool)Sets up automatic sniff/unsniff requesting for the socket.
• SetAutomaticSniffMode(TBool,TInt)Sets up automatic sniff/unsniff requesting for the socket.
• SetLocalPort(TInt)Sets the local port of a Bluetooth socket.
• SetNotifier(MBluetoothSocketNotifier &)Changes the owner (receiver of notifications) of the socket.
• SetOpt(TUint,TUint,TInt)Sets a socket option.
• SetOpt(TUint,TUint,const TDesC8 &)
• SetOption(TUint,TUint,const TDesC8 &)Sets a socket option.
• Transfer(RSocketServ &,const TDesC &)Transfers a socket from one socket server session to another.
• Write(const TDesC8 &)Writes to a remote Bluetooth device
• ~CBluetoothSocket()Destructor

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• RBTPhysicalLinkAdapter::ActivateActiveRequester()Start a facility that will continually attempt to put the physical link into Act...
• CBluetoothSocket::SetAutomaticSniffMode(TBool)Sets up automatic sniff/unsniff requesting for the socket.
• RBTPhysicalLinkAdapterClass to enable modification of a physical link:

IMPORT_C static CBluetoothSocket* NewL(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, TUint aSockType, TUint aProtocol);

Pre-Condition

A session on the socket server has been started.

Description

Standard Bluetooth socket NewL constructor.

Opens a Bluetooth socket. The constructor identifies the server, socket type, and bluetooth protocol to be used for the socket, as well as an asynchronous notifier.

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewLC(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, TUint aSockType, TUint aProtocol);

Description

Standard Bluetooth socket NewLC constructor.

Opens a Bluetooth socket as with the CBluetoothSocket::NewL(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint) above, but leaves the returned CBluetoothSocket object on the cleanup stack.

Parameters

Return value

IMPORT_C static CBluetoothSocket* NewL(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, TUint aSockType, TUint aProtocol, RConnection &aConnection);

Pre-Condition

A session on the socket server has been started.

Description

Opens a Bluetooth socket on a specified connection.

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewLC(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, TUint aSockType, TUint aProtocol, RConnection &aConnection);

Description

This constructor opens a Bluetooth socket on a specified connection.

Leaves the socket on the cleanup stack.

Parameters

Return value

IMPORT_C static CBluetoothSocket* NewL(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, const TDesC &aName);

Pre-Condition

A session on the socket server has been started.

Description

Bluetooth socket named protocol CBluetoothSocket::NewL(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint) constructor.

Opens a Bluetooth socket over a specified named protocol, such as "L2CAP".

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewLC(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, const TDesC &aName);

Description

Bluetooth socket named protocol CBluetoothSocket::NewLC(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint) constructor.

Opens a Bluetooth socket over a specified named protocol, such as "L2CAP". Leaves returned CBluetoothSocket object on the cleanup stack.

Parameters

Return value

IMPORT_C static CBluetoothSocket* NewL(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer);

Pre-Condition

A session on the socket server has been started.

Description

Bluetooth blank socket CBluetoothSocket::NewL(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint) constructor.

Opens a blank socket to be used when accepting an incoming connection. This socket should be used as the parameter when a listening socket calls CBluetoothSocket::Accept(CBluetoothSocket &). When that connection completes this blank socket becomes the Bluetooth socket for that connection.

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewLC(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer);

Pre-Condition

A session on the socket server has been started.

Description

Bluetooth blank socket CBluetoothSocket::NewLC(MBluetoothSocketNotifier &,RSocketServ &,TUint,TUint) constructor

Opens a blank socket to be used when accepting an incoming connection. This socket should be used as the parameter when a listening socket calls CBluetoothSocket::Accept(CBluetoothSocket &). When that connection completes this blank socket becomes the Bluetooth socket for that connection.

Leaves returned CBluetoothSocket object on the cleanup stack.

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewL(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, RSocket &aSocket);

Pre-Condition

A session on the socket server has been started, and aSocket is open and is set as "Transferable" through the KSOEnableTransfer SetOpt.

Description

Bluetooth socket using an existing RSocket instance constructor.

Takes ownership of an existing socket to be used as the underlying connection for this Socket wrapper. This should be used where an existing API returned a RSocket representing a Bluetooth connection.

Parameters

Return value

Leave codes

IMPORT_C static CBluetoothSocket* NewLC(MBluetoothSocketNotifier &aNotifier, RSocketServ &aServer, RSocket &aSocket);

Pre-Condition

A session on the socket server has been started, and aSocket is open and is set as "Transferable" through the KSOEnableTransfer SetOpt.

Description

Bluetooth socket using an existing RSocket instance constructor.

Takes ownership of an existing socket to be used as the underlying connection for this Socket wrapper. This should be used where an existing API returned a RSocket representing a Bluetooth connection.

Leaves returned CBluetoothSocket object on the cleanup stack.

Parameters

Return value

Leave codes

IMPORT_C ~CBluetoothSocket();

Description

Destructor

Cancels any outstanding Bluetooth socket functions and closes the socket. Note sockets should be closed or shutdown before destructor is called.

IMPORT_C TInt Send(const TDesC8 &aDesc, TUint someFlags);

Description

Sends data to a remote bluetooth device.

The CBluetoothSocket::Send(const TDesC8 &,TUint) operation checks that another CBluetoothSocket::Send(const TDesC8 &,TUint) operation isn't already in progress before sending.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleSendCompleteL(TInt).

If Automatic Sniff Mode is active, using this function will not automatically put the link into active mode. If it is required that the link be taken out of sniff mode automatically when data is to be sent then the CBluetoothSocket::Write(const TDesC8 &) function should be used instead.

Parameters

Return value

IMPORT_C TInt Send(const TDesC8 &aDesc, TUint someFlags, TSockXfrLength &aLen);

Description

Sends data to a remote bluetooth device.

The CBluetoothSocket::Send(const TDesC8 &,TUint) operation checks that another CBluetoothSocket::Send(const TDesC8 &,TUint) operation isn't already in progress before sending.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleSendCompleteL(TInt)

If Automatic Sniff Mode is active, using this function will not automatically put the link into active mode. If it is required that the link be taken out of sniff mode automatically when data is to be sent then the CBluetoothSocket::Write(const TDesC8 &) function should be used instead.

Parameters

Return value

IMPORT_C void CancelSend();

Description

Cancels an outstanding Bluetooth CBluetoothSocket::Send(const TDesC8 &,TUint) operation.

Calling the function will cause an outstanding Bluetooth CBluetoothSocket::Send(const TDesC8 &,TUint) operation to complete prematurely.

IMPORT_C TInt Recv(TDes8 &aDesc, TUint flags);

Description

Receives data from a remote Bluetooth device.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt Recv(TDes8 &aDesc, TUint flags, TSockXfrLength &aLen);

Description

Receives data from a remote Bluetooth device.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt RecvOneOrMore(TDes8 &aDesc, TUint flags, TSockXfrLength &aLen);

Description

Receives data from a remote Bluetooth device, completing when data is available.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt).

Parameters

Return value

IMPORT_C void CancelRecv();

Description

Cancels an outstanding CBluetoothSocket::Recv(TDes8 &,TUint) operation.

Calling this function will cause any outstanding receive operation to cancel.

IMPORT_C TInt Read(TDes8 &aDesc);

Description

Receives data from a remote Bluetooth host.

CBluetoothSocket::Read(TDes8 &) is only used with a connected Bluetooth host.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt)

Parameters

Return value

IMPORT_C void CancelRead();

Description

Cancels an outstanding CBluetoothSocket::Read(TDes8 &) operation.

Calling this function will cause any outstanding CBluetoothSocket::Read(TDes8 &) operation to cancel.

IMPORT_C TInt Write(const TDesC8 &aDesc);

Description

Writes to a remote Bluetooth device

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleSendCompleteL(TInt)

If Automatic Sniff Mode is active on this socket instance, then upon calling this function the link will be put into active mode. If no CBluetoothSocket::Write(const TDesC8 &) calls are made for a period of the timeout specified during activation of the automatic sniffing then the link will be put back into sniff mode.

Parameters

Return value

See also:

• CBluetoothSocket::SetAutomaticSniffMode(TBool,TInt)Sets up automatic sniff/unsniff requesting for the socket.
• CBluetoothSocket::SetAutomaticSniffMode(TBool)Sets up automatic sniff/unsniff requesting for the socket.

IMPORT_C void CancelWrite();

Description

Cancels an outstanding CBluetoothSocket::Write(const TDesC8 &) operation.

Calling this operation will cause any outstanding CBluetoothSocket::Write(const TDesC8 &) operation to cancel.

IMPORT_C TInt SendTo(const TDesC8 &aDesc, TSockAddr &aSockAddr, TUint flags);

Description

Sends the aDesc data to the aAddr specified and applies the flags indicated to the operation.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleSendCompleteL(TInt)

If Automatic Sniff Mode is active, using this function will not automatically put the link into active mode. If it is required that the link be taken out of sniff mode automatically when data is to be sent then the CBluetoothSocket::Write(const TDesC8 &) function should be used instead.

Parameters

Return value

IMPORT_C TInt SendTo(const TDesC8 &aDesc, TSockAddr &aSockAddr, TUint flags, TSockXfrLength &aLen);

Description

Sends the aDesc data to the aAddr specified and applies the flags indicated to the operation.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleSendCompleteL(TInt)

If Automatic Sniff Mode is active, using this function will not automatically put the link into active mode. If it is required that the link be taken out of sniff mode automatically when data is to be sent then the CBluetoothSocket::Write(const TDesC8 &) function should be used instead.

Parameters

Return value

IMPORT_C TInt RecvFrom(TDes8 &aDesc, TSockAddr &aSockAddr, TUint flags);

Description

Receives aDesc data from the named remote aAddr Bluetooth device using the flags indicated.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt RecvFrom(TDes8 &aDesc, TSockAddr &aSockAddr, TUint flags, TSockXfrLength &aLen);

Description

Receives aDesc data from the named remote aAddr Bluetooth device using the flags indicated.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleReceiveCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt Connect(TBTSockAddr &aSockAddr);

Description

Opens a connection to a specific Bluetooth device by its address.

The address represents the address of the remote Bluetooth device. A socket may only have one connect operation outstanding at any one time. Once the connect is completed, the socket is ready to send or receive data. If a socket is unbound - i.e. CBluetoothSocket::Bind(TSockAddr &) has not been called yet - then it will automatically have a local address allocated.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleConnectCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt Connect(TBTSockAddr &aSockAddr, const TDesC8 &aConnectDataOut, TDes8 &aConnectDataIn);

Description

Connects to a remote Bluetooth device by address with a defined data-out and data-in descriptor.

The address provided specifies the address of the remote Bluetooth host. Data can be sent in connect request packets, which may be provided in the data-out descriptor, or connect responses, which may be collected in the data-in descriptor.

A socket may only have one connect operation outstanding at any one time. Once the connect is completed, the socket is ready to send or receive data. If a socket is unbound - i.e. CBluetoothSocket::Bind(TSockAddr &) has not been called yet - then it will automatically have a local address allocated.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleConnectCompleteL(TInt).

Parameters

Return value

IMPORT_C TInt Connect(TBTSockAddr &aAddr, TUint16 aServiceBits);

Description

Sets the Service bits in the Class Of Device. If this is successful, the socket then opens a connection to a specific Bluetooth device by its address.

The address represents the address of the remote Bluetooth device. A socket may only have one connect operation outstanding at any one time. Once the connect is completed, the socket is ready to send or receive data. If a socket is unbound - i.e. CBluetoothSocket::Bind(TSockAddr &) has not been called yet - then it will automatically have a local address allocated.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleConnectCompleteL(TInt)

Parameters

Return value

IMPORT_C void CancelConnect();

Description

Cancel an attempted connection.

IMPORT_C TInt Bind(TSockAddr &aSockAddr);

Description

Sets a Bluetooth socket address.

Sets the local address of a socket. When a socket is opened it has no name associated with it, and binding is required so data can be routed to the socket. CBluetoothSocket::Bind(TSockAddr &) should be called before CBluetoothSocket::Listen(TUint) or CBluetoothSocket::Connect(TBTSockAddr &).

Parameters

Return value

IMPORT_C TInt SetLocalPort(TInt aPort);

Description

Sets the local port of a Bluetooth socket.

Setting the local port is equivalent to calling CBluetoothSocket::Bind(TSockAddr &) with only the port set in the address.

Parameters

Return value

IMPORT_C TInt Accept(CBluetoothSocket &aBlankSocket);

Description

Accepts a connection from a remote Bluetooth socket.

The call extracts the first pending connection on a queue of sockets, the queue size being previously specified by CBluetoothSocket::Listen(TUint). On successful completion the blank socket is given the handle of the new socket and it may then be used to transfer data. After completion the accept socket may be used to make further connections with new blank sockets (see Open() on how to open a blank socket).

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleAcceptCompleteL(TInt)

Parameters

Return value

IMPORT_C TInt Accept(CBluetoothSocket &aBlankSocket, TDes8 &aConnectData);

Description

Reserved for future.

Parameters

Return value

IMPORT_C void CancelAccept();

Description

Cancels the CBluetoothSocket::Accept(CBluetoothSocket &) operation.

IMPORT_C TInt Listen(TUint qSize);

Description

Sets up a socket to listen for incoming connections.

Before calling this procedure a socket should be opened using Open() and be bound to a local address using CBluetoothSocket::Bind(TSockAddr &).

CBluetoothSocket::Listen(TUint) creates a queue to hold incoming connections which can be married with blank sockets using CBluetoothSocket::Accept(CBluetoothSocket &).

Once a listen queue has been created it will continue to allow peers to connect until it is full, at which point it will reject any incoming connections as specified by protocol behaviour. When a socket is accepted by the client a space is made available in the queue.

Parameters

Return value

IMPORT_C TInt Listen(TUint qSize, const TDesC8 &aConnectData);

Description

Reserved for future.

Parameters

Return value

IMPORT_C TInt Listen(TUint qSize, TUint16 aServiceBits);

Description

Sets the Service bits in the Class Of Device. If this is successful, the socket will then be set to Listen for incoming connections.

Before calling this procedure a socket should be opened using Open() and be bound to a local address using CBluetoothSocket::Bind(TSockAddr &).

CBluetoothSocket::Listen(TUint) creates a queue to hold incoming connections which can be married with blank sockets using CBluetoothSocket::Accept(CBluetoothSocket &).

Once a listen queue has been created it will continue to allow peers to connect until it is full, at which point it will reject any incoming connections as specified by protocol behaviour. When a socket is accepted by the client a space is made available in the queue.

Parameters

Return value

IMPORT_C TInt SetOpt(TUint aOptionName, TUint aOptionLevel, TInt aOption);

Description

Sets a socket option.

The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be set with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Parameters

Return value

IMPORT_C TInt SetOption(TUint aOptionName, TUint aOptionLevel, const TDesC8 &aOption);

Description

Sets a socket option.

The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be set with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Parameters

Return value

IMPORT_C TInt GetOpt(TUint aOptionName, TUint aOptionLevel, TDes8 &aOption);

Description

Gets a socket option.

The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be got with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Parameters

Return value

IMPORT_C TInt GetOpt(TUint aOptionName, TUint aOptionLevel, TInt &aOption);

Description

Gets a socket option.

The socket server has options which are generic to all sockets and protocols may add specific options.

Options available for all protocols can be got with anOptionLevel set to KSOLSocket. See individual protocol notes for other socket options.

Parameters

Return value

IMPORT_C TInt Ioctl(TUint aLevel, TUint aCommand, TDes8 *aDesc);

Description

Applies an asynchronous control operation on a socket.

Data may be passed and received if a descriptor address is provided as an argument. Only one CBluetoothSocket::Ioctl(TUint,TUint,TDes8 *) operation may be outstanding for each socket.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleIoctlCompleteL(TInt)

Parameters

Return value

IMPORT_C void CancelIoctl();

Description

Cancels the CBluetoothSocket::Ioctl(TUint,TUint,TDes8 *) asynchronous control operation.

IMPORT_C TInt GetDisconnectData(TDes8 &aDesc);

Description

Parameters

Return value

IMPORT_C void LocalName(TSockAddr &aSockAddr);

Description

Gets the local address of a socket.

The local address is set either by calling CBluetoothSocket::Bind(TSockAddr &) or it is automatically set when CBluetoothSocket::Connect(TBTSockAddr &) is called. If a socket is created through CBluetoothSocket::Accept(CBluetoothSocket &) then a socket will inherit the port of its parent unless otherwise specified by a protocol's behaviour.

Parameters

IMPORT_C TUint LocalPort();

Description

Gets the local port of a socket.

Similar to CBluetoothSocket::LocalName(TSockAddr &).

Return value

IMPORT_C void RemoteName(TSockAddr &aSockAddr);

Description

Gets the remote address of a socket.

The remote name (address) of a socket is associated with the remote host the socket is connected to. The remote name is only valid for a connected socket. A socket is either connected through calling CBluetoothSocket::Connect(TBTSockAddr &) or CBluetoothSocket::Accept(CBluetoothSocket &).

Parameters

IMPORT_C TInt Shutdown(RSocket::TShutdown aHow);

Description

Shuts down a connected socket. (The socket cannot be null. The shutdown method allows input and output to be individually stopped for a protocol endpoint.

When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleShutdownCompleteL(TInt)

Parameters

Return value

See also:

• CBluetoothSocket::Info(TProtocolDesc &)Gets information about the protocol the socket is opened on.

IMPORT_C TInt Shutdown(RSocket::TShutdown aHow, const TDesC8 &aDisconnectDataOut, TDes8 &aDisconnectDataIn);

Description

Reserved for future. The socket must not be null. ( When this request completes, notification is sent to the MBluetoothSocketNotifier object supplied when this CBluetoothSocket was constructed. This is done in the function MBluetoothSocketNotifier::HandleShutdownCompleteL(TInt)

Parameters

Return value

See also:

• CBluetoothSocket::Info(TProtocolDesc &)Gets information about the protocol the socket is opened on.

IMPORT_C void CancelAll();

Description

Cancels all outstanding operations.

Calling it will cause all outstanding operations to cancel. Outstanding operations for a socket include: read, write, Ioctl, connect, accept, shutdown and the Baseband event notifier. All of these operations will be completed by this call.

IMPORT_C TInt Info(TProtocolDesc &aProtocol);

Description

Gets information about the protocol the socket is opened on.

Parameters

Return value

IMPORT_C TInt Name(TName &aName);

Description

Used to get a unique name of a socket.

The name is needed when CBluetoothSocket::Transfer(RSocketServ &,const TDesC &) is called.

Parameters

Return value

IMPORT_C TInt Transfer(RSocketServ &aServer, const TDesC &aName);

Description

Transfers a socket from one socket server session to another.

It creates the socket in the target session, and removes the socket from the source session. The call is made on an uninitialised RSocket object. The socket system name 'Name()' is used to identify the socket to transfer.

If the call fails, the socket that is being transferred remains with the original session. Success or failure can be checked on the originating socket by calling CBluetoothSocket::Info(TProtocolDesc &), which returns KErrNone if the transfer failed, and KErrBadHandle if it succeeded.

Parameters

Return value

IMPORT_C TInt PhysicalLinkState(TUint32 &aState);

Description

Get the state of the physical link.

Parameters

Return value

See also:

• RBTPhysicalLinkAdapter::PhysicalLinkState(TUint32 &)Get the state of the physical link.

IMPORT_C TInt PreventRoleSwitch();

Description

Role switching is not allowed.

Return value

See also:

• RBTPhysicalLinkAdapter::PreventRoleSwitch()Blocks a role switch

IMPORT_C TInt AllowRoleSwitch();

Description

Allow the socket to switch roles.

Return value

See also:

• RBTPhysicalLinkAdapter::AllowRoleSwitch()Ensures this object does not block a role switch.

IMPORT_C TInt RequestMasterRole();

Description

Request the socket take on the master role.

Return value

See also:

• RBTPhysicalLinkAdapter::RequestMasterRole()Attempt to be the Bluetooth Master of a Piconet.

IMPORT_C TInt RequestSlaveRole();

Description

Request the socket take on a slave role.

Return value

See also:

• RBTPhysicalLinkAdapter::RequestSlaveRole()Attempt to be a Bluetooth Slave of a Piconet.

IMPORT_C TInt PreventLowPowerModes(TUint32 aLowPowerModes);

Description

Prevents low power modes from being activated.

Parameters

Return value

Panic codes

See also:

• RBTPhysicalLinkAdapter::PreventLowPowerModes(TUint32)Blocks the use of a specified set of low power modes

IMPORT_C TInt AllowLowPowerModes(TUint32 aLowPowerModes);

Description

Allow low power modes.

The power modes are indicated by aLowPowerModes.

Parameters

Return value

Panic codes

See also:

• RBTPhysicalLinkAdapter::AllowLowPowerModes(TUint32)Ensures this object does not block the use of a specified set of low power modes

IMPORT_C TInt ActivateSniffRequester();

Description

Return value

Panic codes

See also:

• RBTPhysicalLinkAdapter::ActivateSniffRequester()Start a facility that will continually attempt to put the physical link into Sni...

IMPORT_C TInt ActivateParkRequester();

Description

Activate park requestor.

Return value

Panic codes

See also:

• RBTPhysicalLinkAdapter::ActivateParkRequester()Start a facility that will continually attempt to put the physical link into Par...

IMPORT_C TInt CancelLowPowerModeRequester();

Description

Cancels the low power mode request.

Return value

Panic codes

See also:

• RBTPhysicalLinkAdapter::CancelLowPowerModeRequester()Cancel a facility that is continually requesting a low power mode

IMPORT_C TInt RequestChangeSupportedPacketTypes(TUint16 aPacketTypes);

Description

Request to change the supported packet types.

Parameters

Return value

See also:

• RBTPhysicalLinkAdapter::RequestChangeSupportedPacketTypes(TUint16)Update the set of baseband packet types that are allowed locally

IMPORT_C TInt ActivateBasebandEventNotifier(TUint32 aEventTypes);

Description

Set up notification of baseband events

Elect to be notified whenever one of a user specified selection of baseband events occurs.

The notification takes place in the pure virtual function MBluetoothSocketNotifier::HandleActivateBasebandEventNotifierCompleteL(TInt,TBTBasebandEventNotification &)

The FIRST notification will take place ALMOST INSTANTANEOUSLY and will be A FULL DESCRIPTION (OR SNAPSHOT) OF THE CURRENT STATE OF THE PHYSICAL LINK irrespective of the specified selection of events wanted. This first notification or snapshot has NOTHING to do with a baseband event occurring. Once this snapshot has taken place, all occurrences of the specified events from the instant of the snapshot onwards will be notified until CBluetoothSocket::CancelBasebandEventNotifier() is called.

Parameters

Return value

See also:

• CBluetoothSocket::PhysicalLinkState(TUint32 &)Get the state of the physical link.
• TBTPhysicalLinkStateNotifier...

IMPORT_C void CancelBasebandEventNotifier();

Description

Cancels an active baseband notifier.

No further baseband events will be notified.

If this function is called when there is no active baseband notifier, it will do nothing.

IMPORT_C void SetNotifier(MBluetoothSocketNotifier &aNewNotifier);

Description

Changes the owner (receiver of notifications) of the socket.

The previous notifier will not be deleted after the change has been made.

Parameters

IMPORT_C TInt SetAutomaticSniffMode(TBool aAutoSniffMode);

Description

Sets up automatic sniff/unsniff requesting for the socket.

If Automatic Sniff requesting is being selected, a timer with default delay in seconds before the idle socket will request the link to go into sniff mode. The CBluetoothSocket::Write(const TDesC8 &) method will clear an outstanding sniff requester and start the CAutoSniffDelayTimer active object which will issue another request for sniff mode once it times out.

If Automatic Sniff requesting is being deselected, a previous sniff requester will be cancelled.

If Automatic Sniff requesting is selected when it is already active, no change will be performed and KErrInUse will be returned

Parameters

Return value

IMPORT_C TInt SetAutomaticSniffMode(TBool aAutoSniffMode, TInt aIdleSecondsBeforeSniffRequest);

Description

Sets up automatic sniff/unsniff requesting for the socket.

If Automatic Sniff requesting is being selected, supply the delay in seconds required before the idle socket will request the link to go into sniff mode. The CBluetoothSocket::Write(const TDesC8 &) method will clear an outstanding sniff requester and start the CAutoSniffDelayTimer active object which will issue another request for sniff mode once it times out.

If Automatic Sniff requesting is being deselected, a previous sniff requester will be cancelled.

If Automatic Sniff requesting is selected when it is already active, no change will be performed and KErrInUse will be returned

Parameters

Return value

IMPORT_C TBool AutomaticSniffMode() const;

Description

Reports the automatic sniff/unsniff requesting status of the socket.

Return value

IMPORT_C void AsyncDelete();

Description

Asynchronous deletion of the CBluetoothSocket object.

Function will cause asynchronous deletion of CBluetoothSocket object. It should be called if associated MBluetoothSocketNotifier needs to delete CBluetoothSocket from any of its callback functions.

IMPORT_C TInt Ioctl(TUint aCommand, TDes8 *aDesc=0,TUint aLevel=KLevelUnspecified);

Description

Parameters

Return value

IMPORT_C TInt SetOpt(TUint aOptionName, TUint aOptionLevel, const TDesC8 &aOption=TPtrC8(0,0));

Description

Parameters

Return value