Collapse all Symbian^3 Product Developer Library

CConnDataTransfer Class Reference

class CConnDataTransfer : public CBase

Base class that any sub-connection client wishing to get sub-connection related data statitics must implement Since 9.1

Inherits from

CConnDataTransfer
- CBase

Public Member Functions
IMPORT_C TInt	DataReceivedNotificationCancel()
IMPORT_C TInt	DataReceivedNotificationRequest(TUint, TUint)
IMPORT_C TInt	DataSentNotificationCancel()
IMPORT_C TInt	DataSentNotificationRequest(TUint, TUint)
IMPORT_C TInt	DataTransferred(TUint &, TUint &)
IMPORT_C TInt	DataTransferredCancel()
IMPORT_C void	DeRegisterClient(MConnDataTransferNotify &)
IMPORT_C void	RegisterClientL(MConnDataTransferNotify &)

Protected Member Functions
	CConnDataTransfer()
TInt	DoDataReceivedNotificationCancel()
TInt	DoDataReceivedNotificationRequest(TUint, TUint)
TInt	DoDataSentNotificationCancel()
TInt	DoDataSentNotificationRequest(TUint, TUint)
TInt	DoDataTransferred(TUint &, TUint &)
TInt	DoDataTransferredCancel()

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

Protected Attributes
RPointerArray< MConnDataTransferNotify >	iClients

Constructor & Destructor Documentation

CConnDataTransfer()

IMPORT_C

CConnDataTransfer

(

)

[protected]

Constructor

Member Functions Documentation

DataReceivedNotificationCancel()

IMPORT_C TInt

DataReceivedNotificationCancel

(

)

Remove the additional notification that this request would have generated

DataReceivedNotificationRequest(TUint, TUint)

IMPORT_C TInt	DataReceivedNotificationRequest	(	TUint	aRequestedGranularity,
			TUint	aRequestedNotificationVolume
		)

Receive a request for a notification after a given volume of data has been received on the sub-connection

Parameters

TUint aRequestedGranularity	The amount of data to be received after which the notification will occur (but see notes); this is relative to the current volume of data received
TUint aRequestedNotificationVolume	The absolute amount of data that should be received before we send a notification; only used if aRequestedGranularity is zero

DataSentNotificationCancel()

IMPORT_C TInt

DataSentNotificationCancel

(

)

Remove the additional notification that this request would have generated

DataSentNotificationRequest(TUint, TUint)

IMPORT_C TInt	DataSentNotificationRequest	(	TUint	aRequestedGranularity,
			TUint	aRequestedNotificationVolume
		)

Receive a request for a notification after a given volume of data has been sent on the sub-connection

Parameters

TUint aRequestedGranularity	The amount of data to be sent after which the notification will occur (but see notes); this is relative to the current volume of data sent
TUint aRequestedNotificationVolume	The absolute amount of data that should be sent before we send a notification; only used if aRequestedGranularity is zero

DataTransferred(TUint &, TUint &)

IMPORT_C TInt	DataTransferred	(	TUint &	aUplinkVolume,
			TUint &	aDownlinkVolume
		)

Calculate out how much data has been sent and received on the sub-connection

Parameters

TUint & aUplinkVolume	On return, contains the amount of data sent on this subconnection
TUint & aDownlinkVolume	On return, contains the amount of data received on this subconnection

DataTransferredCancel()

IMPORT_C TInt

DataTransferredCancel

(

)

Cancel a request for data transfer information

DeRegisterClient(MConnDataTransferNotify &)

IMPORT_C void

DeRegisterClient

(

MConnDataTransferNotify &

aClient

)

De-register a client

Parameters

MConnDataTransferNotify & aClient

Reference to the MConnDataTransferNotify derived class as the client

DoDataReceivedNotificationCancel()

TInt

DoDataReceivedNotificationCancel

(

)

[protected, pure virtual]

Override this to remove the additional notification that this request would have generated

DoDataReceivedNotificationRequest(TUint, TUint)

TInt	DoDataReceivedNotificationRequest	(	TUint	aRequestedGranularity,
			TUint	aRequestedNotificationVolume
		)	[protected, pure virtual]

Override this to receive a request for a notification after a given volume of data has been received on the sub-connection

Parameters

TUint aRequestedGranularity	The amount of data to be received after which the notification will occur (but see notes); this is relative to the current volume of data received
TUint aRequestedNotificationVolume	The absolute amount of data that should be received before we send a notification; only used if aRequestedGranularity is zero

DoDataSentNotificationCancel()

TInt

DoDataSentNotificationCancel

(

)

[protected, pure virtual]

Override this to remove the additional notification that this request would have generated

DoDataSentNotificationRequest(TUint, TUint)

TInt	DoDataSentNotificationRequest	(	TUint	aRequestedGranularity,
			TUint	aRequestedNotificationVolume
		)	[protected, pure virtual]

Override this to receive a request for a notification after a given volume of data has been sent on the sub-connection

Parameters

TUint aRequestedGranularity	The amount of data to be sent after which the notification will occur (but see notes); this is relative to the current volume of data sent
TUint aRequestedNotificationVolume	The absolute amount of data that should be sent before we send a notification; only used if aRequestedGranularity is zero

DoDataTransferred(TUint &, TUint &)

TInt	DoDataTransferred	(	TUint &	aUplinkVolume,
			TUint &	aDownlinkVolume
		)	[protected, pure virtual]

Override this to register for data transfer notification on the sub-connection

Parameters

TUint & aUplinkVolume	On return, contains the amount of data sent on this subconnection
TUint & aDownlinkVolume	On return, contains the amount of data received on this subconnection

DoDataTransferredCancel()

TInt

DoDataTransferredCancel

(

)

[protected, pure virtual]

Override this to cancel a request for data transfer information

RegisterClientL(MConnDataTransferNotify &)

IMPORT_C void

RegisterClientL

(

MConnDataTransferNotify &

aClient

)

Parameters

MConnDataTransferNotify & aClient

Reference to the MConnDataTransferNotify derived class as the client

Member Data Documentation

RPointerArray< MConnDataTransferNotify > iClients

RPointerArray< MConnDataTransferNotify >

iClients

[protected]