examples/RemoteConn/MtpDataProviderExample/inc/cmtpexampledprequestprocessor.h

/*
Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: 
*/


#ifndef __CMTPEXAMPLEDPREQUESTPROCESSOR_H__
#define __CMTPEXAMPLEDPREQUESTPROCESSOR_H__

#include <e32base.h>
#include <mtp/mtpdataproviderapitypes.h>
#include <mtp/mtpprotocolconstants.h>
#include <mtp/tmtptyperesponse.h>
#include <mtp/tmtptypenull.h>


class TMTPTypeRequest;
class CMTPDataProviderPlugin;
class MMTPDataProviderFramework;
class TMTPTypeEvent;

struct TMTPRequestElementInfo; 

class MMTPExampleDpRequestProcessor
        {
public: 
        /*
        Process a request from the initiator
        @param aRequest The request to be processed
        @param aPhase   The transaction phase of the request
        @return ETrue to signal that the processor object can be deleted, EFalse to keep the processor object
        */
        virtual TBool HandleRequestL(const TMTPTypeRequest& aRequest, TMTPTransactionPhase aPhase) = 0;
        
        /*
        Process an event from the initiator
        @param aEvent   The event to be processed
        */
        virtual void HandleEventL(const TMTPTypeEvent& aEvent) = 0;
        
        /*
    Check if the processor matches the request on the connection
    @param aRequest The request to be checked
    @param aConnection The connection from which the request comes
    @return ETrue to indicate the processor can handle the request, otherwise, EFalse
    */
    virtual TBool Match(const TMTPTypeRequest& aRequest, MMTPConnection& aConnection) const = 0;
        
        /*
        Check if the processor matches the event on the connection
        @param aEvent The event to be checked
        @param aConnection The connection from which the event comes
        @return ETrue to indicate the processor can handle the event, otherwise, EFalse
        */      
        virtual TBool Match(const TMTPTypeEvent& aEvent, MMTPConnection& aConnection) const = 0;
        
        /*
        Get the request object which the processor is currently handling
        @return the request object which the processor is currently handling
        */
        virtual const TMTPTypeRequest& Request() const = 0;
        
        /*
        Get the connection object associated with the current request object
        @return the connection object associated with the current request object
        */
        virtual MMTPConnection& Connection() const = 0;
    /*
    Get the Session ID associated with the current request object
    @return Session ID associated with the current request object
    */  
        
        virtual TUint32 SessionId() = 0;
   /*
    delete the request processor object
    */
    virtual void Release() = 0;

        };

typedef MMTPExampleDpRequestProcessor* (*TMTPRequestProcessorCreateFunc)(
                                                                                                                                MMTPDataProviderFramework& aFramework, 
                                                                                                                                MMTPConnection& aConnection);

typedef struct 
        {
        TUint16                                                 iOperationCode;
        TMTPRequestProcessorCreateFunc  iCreateFunc;
        }TMTPRequestProcessorEntry;

class CMTPExampleDpRequestProcessor : public MMTPExampleDpRequestProcessor
    {
protected:  
    CMTPExampleDpRequestProcessor(
                        MMTPDataProviderFramework& aFramework,
                        MMTPConnection& aConnection,
                        TInt aElementCount,
                        const TMTPRequestElementInfo* aElements);
    virtual ~CMTPExampleDpRequestProcessor();   

protected:  //utility methods   
    void SendResponseL(TMTPResponseCode aResponseCode, TInt aParameterCount = 0, TUint32* aParams = NULL);
    void CompleteRequestL();
        
protected:  //  from MMTPRequestProcessor   
    virtual TBool HandleRequestL(const TMTPTypeRequest& aRequest, TMTPTransactionPhase aPhase);
    virtual void HandleEventL(const TMTPTypeEvent& aEvent);
    virtual void Release();
    virtual TBool Match(const TMTPTypeRequest& aRequest, MMTPConnection& aConnection) const;
    virtual TBool Match(const TMTPTypeEvent& aEvent, MMTPConnection& aConnection) const;  
    virtual const TMTPTypeRequest& Request() const;
    virtual MMTPConnection& Connection() const;
    virtual TUint32 SessionId();


protected:  //new virtuals  
    virtual TBool DoHandleResponsePhaseL();
    virtual TBool DoHandleCompletingPhaseL();
    
    /*
    service a request at request phase
    */
    virtual void ServiceL() = 0;

private:
    void ExtractSessionTransactionId();                 
    
protected:
    MMTPDataProviderFramework&      iFramework;
    const TMTPTypeRequest*          iRequest;           //the pending request object.
    MMTPConnection&                 iConnection;        //the connection from which the request comes.
    TMTPTypeResponse                iResponse;          //the response object to send to the initiator.
    TBool                           iCancelled;         //indicates whether the data phase (send/receive) has been cancelled.
    TInt                            iElementCount;      //number of verification elements used for request checker.
    const TMTPRequestElementInfo*   iElements;          //pointer to an array of verification elements.
    TUint32                         iSessionId;         //session id for the pending request.
    TUint32                         iTransactionCode;   //transaction code for the pending request.

private:
    TMTPResponseCode                iResponseCode;      // contains response from CheckRequestL call.
    };

#endif // __CMTPEXAMPLEDPREQUESTPROCESSOR_H__

---