Collapse all Symbian^3 Application Developer Library

MMTPDataProvider Class Reference

class MMTPDataProvider

Defines the MTP data provider Service Provider Interface (SPI).

Public Member Functions
void	Cancel ()
IMPORT_C TAny *	GetExtendedInterface ( TUid )
void	ProcessEventL (const TMTPTypeEvent &, MMTPConnection &)
void	ProcessNotificationL ( TMTPNotification , const TAny *)
void	ProcessRequestPhaseL ( TMTPTransactionPhase , const TMTPTypeRequest &, MMTPConnection &)
IMPORT_C void	StartObjectEnumerationL ( TUint32 )
IMPORT_C void	StartObjectEnumerationL ( TUint32 , TBool )
void	StartStorageEnumerationL ()
void	Supported ( TMTPSupportCategory , RArray < TUint > &)
IMPORT_C void	SupportedL ( TMTPSupportCategory , CDesCArray &)

Protected Member Functions
MMTPDataProviderFramework &	Framework ()

Member Functions Documentation

Cancel()

void

Cancel

(

)

[pure virtual]

Cancels the most recent outstanding request made to the MTP data provider service provider interface. If there is no such request outstanding, then no action is taken.

Framework()

MMTPDataProviderFramework &

Framework

(

)

const [protected, pure virtual]

Provides a handle to the MTP data provider framework layer interface.

GetExtendedInterface(TUid)

IMPORT_C TAny *

GetExtendedInterface

(

TUid

aInterfaceUid

)

[virtual]

Provides an MTP data provider extension interface implementation for the specified interface Uid.

Parameters

TUid aInterfaceUid

The unique identifier for the extension interface being requested.

ProcessEventL(const TMTPTypeEvent &, MMTPConnection &)

void	ProcessEventL	(	const TMTPTypeEvent &	aEvent,
			MMTPConnection &	aConnection
		)	[pure virtual]

Notifies the data provider that an asynchronous event dataset has been received on the specified MTP connection.

leave: One of the system wide error code, if a processing failure occurs in the data provider.

Parameters

const TMTPTypeEvent & aEvent	The MTP event dataset.
MMTPConnection & aConnection	The MTP connection on which the event was received.

ProcessNotificationL(TMTPNotification, const TAny *)

void	ProcessNotificationL	(	TMTPNotification	aNotification,
			const TAny *	aParams
		)	[pure virtual]

Notifies the data provider of a significant event which has been detected. Additional details regarding the event may optionally be provided in the accompanying notification parameter block.

leave: One of the system wide error code if a processing failure occurs in the data provider.

Parameters

TMTPNotification aNotification	The notification type identifier.
const TAny * aParams	The notification type specific parameter block

ProcessRequestPhaseL(TMTPTransactionPhase, const TMTPTypeRequest &, MMTPConnection &)

void	ProcessRequestPhaseL	(	TMTPTransactionPhase	aPhase,
			const TMTPTypeRequest &	aRequest,
			MMTPConnection &	aConnection
		)	[pure virtual]

Initiates an MTP transaction phase processing sequence in the data provider. The data provider must respond by issuing a signal to the MTP data provider framework layer interface that is appropriate for the request type and current phase (as specified by aPhase) of the MTP transaction being processed, as follows:

MTP Transaction Phase Valid MMTPDataProviderFramework Signal --------------------- -------------------------------------- ERequestPhase ReceiveDataL, SendDataL, SendResponseL EResponsePhase SendResponseL ECompletingPhase TransactionCompleteL

MMTPDataProviderFramework::ReceiveDataL MMTPDataProviderFramework::SendDataL MMTPDataProviderFramework::SendResponseL MMTPDataProviderFramework::TransactionCompleteL

leave: One of the system wide error code if a processing failure occurs in the data provider.

Parameters

TMTPTransactionPhase aPhase	The MTP transaction phase to be processed.
const TMTPTypeRequest & aRequest	The MTP request dataset of the active MTP transaction.
MMTPConnection & aConnection	The MTP connection on which the transaction is being processed.

StartObjectEnumerationL(TUint32)

IMPORT_C void

StartObjectEnumerationL

(

TUint32

aStorageId

)

[virtual]

. Initiates an object store enumeration sequence to enumerate all MTP data objects which reside on the specified storage and for which the data provider is responsible. The data provider is expected to invoke the appropriate MMTPObjectMgr methods to enumerate all MTP data objects for which it is responsible and which it wishes to have presented to a connected MTP initiator. The data provider must complete the sequence by signalling ObjectEnumerationCompleteL to the data provider framework layer interface.

leave: One of the system wide error code if a processing failure occurs in the data provider.

MMTPDataProviderFramework::ObjectEnumerationCompleteL

Parameters

TUint32 aStorageId

The MTP StorageID of the storage to be enumerated. A value of KMTPStorageAll indicates that all storages should be enumerated.

StartObjectEnumerationL(TUint32, TBool)

IMPORT_C void	StartObjectEnumerationL	(	TUint32	aStorageId,
			TBool	aPersistentFullEnumeration
		)	[virtual]

Initiates an object store enumeration sequence to enumerate all MTP data objects which reside on the specified storage and for which the data provider is responsible. The data provider is expected to invoke the appropriate MMTPObjectMgr methods to enumerate all MTP data objects for which it is responsible and which it wishes to have presented to a connected MTP initiator. The data provider must complete the sequence by signalling ObjectEnumerationCompleteL to the data provider framework layer interface.

leave: One of the system wide error code if a processing failure occurs in the data provider.

MMTPDataProviderFramework::ObjectEnumerationCompleteL

Parameters

TUint32 aStorageId	The MTP StorageID of the storage to be enumerated. A value of KMTPStorageAll indicates that all storages should be enumerated.
TBool aPersistentFullEnumeration	It is used by only persistent data providers, it indicates whether the persistent data providers should do the object full-enumreation or not.

StartStorageEnumerationL()

void

StartStorageEnumerationL

(

)

[pure virtual]

Initiates a storage enumeration sequence. The data provider is expected to invoke the appropriate MMTPStorageMgr methods to enumerate all MTP storages for which it is responsible and which it wishes to have presented to a connected MTP initiator. The data provider must complete the sequence by signalling StorageEnumerationCompleteL to the data provider framework layer interface.

leave: One of the system wide error code if a processing failure occurs in the data provider.

MMTPDataProviderFramework::StorageEnumerationCompleteL

Supported(TMTPSupportCategory, RArray< TUint > &)

void	Supported	(	TMTPSupportCategory	aCategory,
			RArray < TUint > &	aCodes
		)	const [pure virtual]

Provides the set of MTP datacodes of the specified category that are supported by the data provider.

Parameters

TMTPSupportCategory aCategory	The requested MTP datacode category.
RArray < TUint > & aCodes

SupportedL(TMTPSupportCategory, CDesCArray &)

IMPORT_C void	SupportedL	(	TMTPSupportCategory	aCategory,
			CDesCArray &	aStrings
		)	const [virtual]

Provides the MTP string values of the specified category that is supported by the data provider.

leave: One of the system wide error code if a processing failure occurs in the data provider.

Parameters

TMTPSupportCategory aCategory	The requested MTP datacode category.
CDesCArray & aStrings	On successful completion, the set of string data that are supported by the data provider.