Class CCHFEcomDataSupplier

class CCHFEcomDataSupplier : public CCHFDataSupplier;

Description

Base class for all data suppliers that are provided via ECom plugins.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CActive - The core class of the active object abstraction.

• CCHFDataSupplier - Base class for all Content Handling Framework Data Suppliers.

• CCHFEcomDataSupplier - Base class for all data suppliers that are provided via ECom plugins.

Members

Defined in CCHFEcomDataSupplier:

• CCHFEcomDataSupplier(TInt)Constructor.
• NewL(CCHFDiscoveryService &,const TDesC8 &,TUint)Factory for data suppliers provided by ECom plug-ins.
• TParamsParameters to pass to the data supplier factory function.
• ~CCHFEcomDataSupplier()Destructor.

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• DoCancel()Implements cancellation of an outstanding request.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• RunL()Handles an active object's request completion event.
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CCHFDataSupplier:

• BaseConstructL(const TDesC8 &)Initialises the Data Supplier base class. Call this method in your derived class...
• CCHFDataSupplier(TInt)Constructor.
• ContentType(TPtrC8 &)constGets the content type of the resource.
• EContentTypeKnownContent type is known.
• EContentTypeUnknownContent type is unknown.
• File()The public calling API for getting the file-handle of the resource, if the conte...
• NewFromFileHandleL(RFile &,TUint)Creates a CCHFDataSupplier object given a file-handle (rather than a URI).
• Observer()constGets the data supplier's observer.
• Read(TPtrC8 &)Reads the portion of data received.
• RecognizeDataL(RFile &)Attempts recognition of the content MIME type.
• RecognizeDataL(const TDesC &,const TDesC8 &)Attempts recognition of the content MIME type.
• Reset()Called by the client to reinitialise the data connection.
• ResourceSize()constGets the resource's total content size.
• Resume()Resumes the Data Supplier from a suspended state.
• RxReady()Called by the client to indicate readiness to receive more data.
• SetContentTypeL(const TDesC8 &)Sets the content type to a client-specified value.
• SetObserver(MCHFDataSupplierObserver &)Replaces the current Data Supplier Observer.
• SetReadPosition(TUint32)Sets the data supplier read position.
• SetReadPosition(TUint32,TUint32)Sets the range of data to be read.
• Start(MCHFDataSupplierObserver &)Starts the Data Supplier call to supply an observer interface and to request the...
• Suspend()Suspends activity on the Data Supplier.
• TContentTypeStatusDescribes the status of the content type buffer; whether known, i.e. set, or not...
• Uri()constGets the URI of the resource.
• iContentStatusHolds the status of the content type buffer.

static inline CCHFEcomDataSupplier* NewL(CCHFDiscoveryService &aDiscoveryService, const TDesC8 &aUri, TUint aBufferSizeInBytes);

Description

Factory for data suppliers provided by ECom plug-ins.

Parameters

CCHFDiscoveryService &aDiscoveryService Discovery service const TDesC8 &aUri URI used to find data supplier TUint aBufferSizeInBytes Size of the portion of data that can be handled by the client at a time.

Return value

CCHFEcomDataSupplier *

inline ~CCHFEcomDataSupplier();

Description

Destructor.

inline CCHFEcomDataSupplier(TInt aPriority);

Description

Constructor.

Parameters

TInt aPriority Active Object priority to be applied to the data supplier object.

protected: class TParams;

Description

Parameters to pass to the data supplier factory function.

Members

Defined in CCHFEcomDataSupplier::TParams:

• TParams(CCHFDiscoveryService &,const TDesC8 &,TUint)Constructor.
• iBufferSizeInBytesBuffer size: indicates the size of the portion of data that can be handled by th...
• iDiscoveryServiceDiscovery service
• iUriURI used to find data supplier

Construction and destruction

---

TParams(CCHFDiscoveryService &,const TDesC8 &,TUint)

inline TParams(CCHFDiscoveryService &aDiscoveryService, const TDesC8 &aUri, TUint aBufferSizeInBytes);

Description

Constructor.

Parameters

CCHFDiscoveryService &aDiscoveryService Discovery service const TDesC8 &aUri URI used to find data supplier TUint aBufferSizeInBytes Size of the portion of data that can be handled by the client at a time.

Member data

---

iDiscoveryService

CCHFDiscoveryService & iDiscoveryService;

Description

Discovery service

---

iUri

const TDesC8 & iUri;

Description

URI used to find data supplier

---

iBufferSizeInBytes

TUint iBufferSizeInBytes;

Description

Buffer size: indicates the size of the portion of data that can be handled by the client at a time.