Symbian^3 Application Developer Library >

MBluetoothSocketNotifier Class Reference

class MBluetoothSocketNotifier

This allows for notification of events relating to a CBluetoothSocket object.

Such notification consists of notification of logical link events (for example receipt of a user packet) and physical link state events (for example change of power mode).

Mixin class to be used with CBluetoothSocket

Public Member Functions
void HandleAcceptCompleteL ( TInt )
void HandleActivateBasebandEventNotifierCompleteL ( TInt , TBTBasebandEventNotification &)
void HandleConnectCompleteL ( TInt )
void HandleIoctlCompleteL ( TInt )
void HandleReceiveCompleteL ( TInt )
void HandleSendCompleteL ( TInt )
void HandleShutdownCompleteL ( TInt )
IMPORT_C void MBSN_ExtensionInterfaceL ( TUid , void *&)

Member Functions Documentation

HandleAcceptCompleteL(TInt)

void HandleAcceptCompleteL ( TInt aErr ) [pure virtual]

Notification of an accept complete event.

If no error is reported, then we have accepted a connection request and that connection is ready for use.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

HandleActivateBasebandEventNotifierCompleteL(TInt, TBTBasebandEventNotification &)

void HandleActivateBasebandEventNotifierCompleteL ( TInt aErr,
TBTBasebandEventNotification & aEventNotification
) [pure virtual]

Notification of a baseband event.

If no error is reported, then a baseband event has been retrieved successfully.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

TBTPhysicalLinkStateNotifier

Parameters

TInt aErr the returned error
TBTBasebandEventNotification & aEventNotification

HandleConnectCompleteL(TInt)

void HandleConnectCompleteL ( TInt aErr ) [pure virtual]

Notification of a connection complete event.

If no error is reported, then the connection is ready for use.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

HandleIoctlCompleteL(TInt)

void HandleIoctlCompleteL ( TInt aErr ) [pure virtual]

Notification of a ioctl complete event.

An HCI request that has an associated command complete has completed.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

HandleReceiveCompleteL(TInt)

void HandleReceiveCompleteL ( TInt aErr ) [pure virtual]

Notification of a receive complete event.

If no error is reported, then then we have successfully received a specified quantity of data.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

HandleSendCompleteL(TInt)

void HandleSendCompleteL ( TInt aErr ) [pure virtual]

Notification of a send complete event.

If no error is reported, then an attempt to send data over Bluetooth has succeeded.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

HandleShutdownCompleteL(TInt)

void HandleShutdownCompleteL ( TInt aErr ) [pure virtual]

Notification of a shutdown complete event.

If no error is reported, then the connection has been closed.
Note:

If the implementation of this function needs to delete associated CBluetoothSocket object, it should NOT use delete operator. The implementation should call CBluetoothSocket::AsyncDelete() method instead.

Parameters

TInt aErr the returned error

MBSN_ExtensionInterfaceL(TUid, void *&)

IMPORT_C void MBSN_ExtensionInterfaceL ( TUid aInterface,
void *& aObject
) [virtual]

Returns a null aObject if the extension is not implemented, or a pointer to another interface if it is. This virtual function allows the M- class to be extended in future in a binary compatible way by providing a method that clients can override in future to allow extra callbacks to be made via aObject.

Parameters

TUid aInterface UID of the interface to return
void *& aObject the container for another interface as specified by aInterface

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.