Collapse all Symbian^3 Product Developer Library

CDiskNotifyHandlerImpl Class Reference

class CDiskNotifyHandlerImpl : public CBase

Class provides actual implementation of disk notify handler.

Since: S60 5.0

Inherits from

CDiskNotifyHandlerImpl
- CBase

Public Member Functions
	~CDiskNotifyHandlerImpl()
TInt	AllowDismount(TInt)
void	CancelNotifyDisk()
void	CancelNotifyDiskSpace(const TInt64 &, TInt)
void	CancelNotifyDiskSpace(TInt)
void	CancelNotifyDiskSpace()
void	CancelNotifyDismount(TInt)
void	CancelNotifyDismount()
void	CancelNotifyEntry(TNotifyType, const TDesC &)
void	CancelNotifyEntry(const TDesC &)
void	CancelNotifyEntry()
void	CancelStartedDismount(TInt)
void	CancelStartedDismount()
CDiskNotifyHandlerImpl *	NewL(MDiskNotifyHandlerCallback &, RFs &)
TInt	NotifyDisk()
TInt	NotifyDiskSpace(const TInt64 &, TInt)
TInt	NotifyDismount(TInt)
TInt	NotifyEntry(TNotifyType, const TDesC &)
TInt	StartDismount(TInt, TTimeIntervalMicroSeconds32)

Private Member Functions
	CDiskNotifyHandlerImpl(MDiskNotifyHandlerCallback &, RFs &)

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

Private Attributes
MDiskNotifyHandlerCallback &	iCallback
RPointerArray< CDiskSpaceWatcher >	iDiskSpaceWatcherList
CDiskWatcher *	iDiskWatcher
RPointerArray< CDismountWatcher >	iDismountWatcherList
RPointerArray< CEntryWatcher >	iEntryWatcherList
RFs &	iFs
RPointerArray< CStartedDismountWatcher >	iStartedDismountWatcherList

Constructor & Destructor Documentation

CDiskNotifyHandlerImpl(MDiskNotifyHandlerCallback &, RFs &)

CDiskNotifyHandlerImpl	(	MDiskNotifyHandlerCallback &	aCallback,
		RFs &	aFs
	)	[private]

C++ default constructor.

Parameters

MDiskNotifyHandlerCallback & aCallback
RFs & aFs

~CDiskNotifyHandlerImpl()

~CDiskNotifyHandlerImpl

(

)

Destructor.

Member Functions Documentation

AllowDismount(TInt)

TInt

AllowDismount

(

TInt

aDrive

)

Allows the dismount of given drive.

Since: S60 5.0

Parameters

TInt aDrive

A drive identifier specified by TDriveNumber

CancelNotifyDisk()

void

CancelNotifyDisk

(

)

Cancels listening for disk notifications.

Since: S60 5.0

CancelNotifyDiskSpace(const TInt64 &, TInt)

void	CancelNotifyDiskSpace	(	const TInt64 &	aThreshold,
			TInt	aDrive
		)

Cancels listening for disk space notifications with given threshold.

Since: S60 5.0

Parameters

const TInt64 & aThreshold	A threshold that causes notification when crossed.
TInt aDrive	A drive identifier specified by TDriveNumber

CancelNotifyDiskSpace(TInt)

void

CancelNotifyDiskSpace

(

TInt

aDrive

)

Cancels listening for all disk space notifications with given drive.

Since: S60 5.0

Parameters

TInt aDrive

A drive identifier specified by TDriveNumber

CancelNotifyDiskSpace()

void

CancelNotifyDiskSpace

(

)

Cancels listening for all disk space notifications.

Since: S60 5.0

CancelNotifyDismount(TInt)

void

CancelNotifyDismount

(

TInt

aDrive

)

Cancels listening for dismount notifications.

Since: S60 5.0

Parameters

TInt aDrive

A drive identifier specified by TDriveNumber

CancelNotifyDismount()

void

CancelNotifyDismount

(

)

Cancels listening for all dismount notifications.

Since: S60 5.0

CancelNotifyEntry(TNotifyType, const TDesC &)

void	CancelNotifyEntry	(	TNotifyType	aType,
			const TDesC &	aEntry
		)

Cancels listening for entry (i.e. file or folder) change notifications with given entry and notify type.

Since: S60 5.0

Parameters

TNotifyType aType	A type of notification specified by TNotifyType.
const TDesC & aEntry	A full path of the file or folder to be listened.

CancelNotifyEntry(const TDesC &)

void

CancelNotifyEntry

(

const TDesC &

aEntry

)

Cancels listening for all entry (i.e. file or folder) change notifications with given entry.

Since: S60 5.0

Parameters

const TDesC & aEntry

A full path of the file or folder to be listened.

CancelNotifyEntry()

void

CancelNotifyEntry

(

)

Cancels listening for all entry (i.e. file or folder) change notifications.

Since: S60 5.0

CancelStartedDismount(TInt)

void

CancelStartedDismount

(

TInt

aDrive

)

Cancels started dismount of given drive.

Since: S60 5.2

Parameters

TInt aDrive

A drive identifier specified by TDriveNumber

CancelStartedDismount()

void

CancelStartedDismount

(

)

Cancels started dismount of all drives.

Since: S60 5.2

NewL(MDiskNotifyHandlerCallback &, RFs &)

CDiskNotifyHandlerImpl *	NewL	(	MDiskNotifyHandlerCallback &	aCallback,
			RFs &	aFs
		)	[static]

This is a two-phase constructor method that is used to create a new instance for listening to the disk changes.

Since: S60 5.0

Parameters

MDiskNotifyHandlerCallback & aCallback	Reference to a callback instance, MDiskNotifyHandlerCallback
RFs & aFs	Reference to an open file server session

NotifyDisk()

TInt

NotifyDisk

(

)

Starts listening for disk notifications.

Since: S60 5.0

NotifyDiskSpace(const TInt64 &, TInt)

TInt	NotifyDiskSpace	(	const TInt64 &	aThreshold,
			TInt	aDrive
		)

Starts listening for disk space notifications.

Since: S60 5.0

Parameters

const TInt64 & aThreshold	A threshold that causes notification when crossed.
TInt aDrive	A drive identifier specified by TDriveNumber

NotifyDismount(TInt)

TInt

NotifyDismount

(

TInt

aDrive

)

Starts listening for dismount notifications.

Since: S60 5.0

Parameters

TInt aDrive

A drive identifier specified by TDriveNumber

NotifyEntry(TNotifyType, const TDesC &)

TInt	NotifyEntry	(	TNotifyType	aType,
			const TDesC &	aEntry
		)

Starts listening for entry (i.e. file or folder) change notifications.

Since: S60 5.0

Parameters

TNotifyType aType	A type of notification specified by TNotifyType.
const TDesC & aEntry	A full path of the file or folder to be listened.

StartDismount(TInt, TTimeIntervalMicroSeconds32)

TInt	StartDismount	(	TInt	aDrive,
			TTimeIntervalMicroSeconds32	aForcedTimeout
		)

Starts dismount with sending notification to registered clients. If dismount is pending after given timeout, forced dismount is done.

Since: S60 5.2

Parameters

TInt aDrive	A drive identifier specified by TDriveNumber
TTimeIntervalMicroSeconds32 aForcedTimeout	A timeout to forced dismount in micro seconds.

Member Data Documentation

MDiskNotifyHandlerCallback & iCallback

MDiskNotifyHandlerCallback &

iCallback

[private]

RPointerArray< CDiskSpaceWatcher > iDiskSpaceWatcherList

RPointerArray< CDiskSpaceWatcher >

iDiskSpaceWatcherList

[private]

CDiskWatcher * iDiskWatcher

CDiskWatcher *

iDiskWatcher

[private]

RPointerArray< CDismountWatcher > iDismountWatcherList

RPointerArray< CDismountWatcher >

iDismountWatcherList

[private]

RPointerArray< CEntryWatcher > iEntryWatcherList

RPointerArray< CEntryWatcher >

iEntryWatcherList

[private]

RFs & iFs

RFs &

iFs

[private]

RPointerArray< CStartedDismountWatcher > iStartedDismountWatcherList

RPointerArray< CStartedDismountWatcher >

iStartedDismountWatcherList

[private]