CConnDataTransfer Class Reference

#include <comms-infras/ss_datatransfer.h>

class CConnDataTransfer : public CBase, public CBase

Inherits from

CConnDataTransfer
- CBase
- CBase

Protected Attributes
RPointerArray< MConnDataTransferNotify >	iClients

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()
pure virtual TInt	DoDataReceivedNotificationCancel()
pure virtual TInt	DoDataReceivedNotificationRequest(TUint, TUint)
pure virtual TInt	DoDataSentNotificationCancel()
pure virtual TInt	DoDataSentNotificationRequest(TUint, TUint)
pure virtual TInt	DoDataTransferred(TUint &, TUint &)
pure virtual 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()

Detailed Description

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

Member Attribute Documentation

iClients

RPointerArray< MConnDataTransferNotify >

iClients

[protected]

Constructor & Destructor Documentation

CConnDataTransfer ( )

IMPORT_C

CConnDataTransfer

(

)

[protected]

Constructor

Member Function Documentation

DataReceivedNotificationCancel ( )

IMPORT_C TInt

DataReceivedNotificationCancel

(

)

Remove the additional notification that this request would have generated

Return Value: KErrNone, or one of the system-wide error codes

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
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
aRequestedNotificationVolume	The absolute amount of data that should be received before we send a notification; only used if aRequestedGranularity is zero

Return Value: KErrNone, or one of the system-wide error codes

DataSentNotificationCancel ( )

IMPORT_C TInt

DataSentNotificationCancel

(

)

Remove the additional notification that this request would have generated

Return Value: KErrNone, or one of the system-wide error codes

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
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
aRequestedNotificationVolume	The absolute amount of data that should be sent before we send a notification; only used if aRequestedGranularity is zero

Return Value: KErrNone, or one of the system-wide error codes

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
aUplinkVolume	On return, contains the amount of data sent on this subconnection
aDownlinkVolume	On return, contains the amount of data received on this subconnection

Return Value: KErrNone if successful, otherwise one of the system-wide error codes

DataTransferredCancel ( )

IMPORT_C TInt

DataTransferredCancel

(

)

Cancel a request for data transfer information

Return Value: ETrue to indicate that the operation is completed here

DeRegisterClient ( MConnDataTransferNotify & )

IMPORT_C void

DeRegisterClient

(

MConnDataTransferNotify &

aClient

)

De-register a client

Parameters
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

Return Value: KErrNone, or one of the system-wide error codes

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
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
aRequestedNotificationVolume	The absolute amount of data that should be received before we send a notification; only used if aRequestedGranularity is zero

Return Value: KErrNone, or one of the system-wide error codes

DoDataSentNotificationCancel ( )

TInt

DoDataSentNotificationCancel

(

)

[protected, pure virtual]

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

Return Value: KErrNone, or one of the system-wide error codes

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
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
aRequestedNotificationVolume	The absolute amount of data that should be sent before we send a notification; only used if aRequestedGranularity is zero

Return Value: KErrNone, or one of the system-wide error codes

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
aUplinkVolume	On return, contains the amount of data sent on this subconnection
aDownlinkVolume	On return, contains the amount of data received on this subconnection

Return Value: KErrNone if successful, otherwise one of the system-wide error codes

DoDataTransferredCancel ( )

TInt

DoDataTransferredCancel

(

)

[protected, pure virtual]

Override this to cancel a request for data transfer information

Return Value: ETrue to indicate that the operation is completed here

RegisterClientL ( MConnDataTransferNotify & )

IMPORT_C void

RegisterClientL

(

MConnDataTransferNotify &

aClient

)

Parameters
aClient	Reference to the MConnDataTransferNotify derived class as the client