Msrp/MsrpServer/inc/CMSRPMsgParser.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 25 505ad3f0ce5c
permissions -rw-r--r--
This release addresses the following issues: 1. The crash bug fix when receiving file 2. Now the sending is based on MSRP messages, there is no longer file receiving or sending. Client sends data as MSRP was designed. 3. Soma MSRP stack was created so that the client told the correct session-id, Symbian stack generated it by itself. This is not allowed, it was changed so that clients tell the session-id (same as used in SIP INVITE). 4. Unnecessary division of data to chunks removed when there is no need to interrupt sending. The message is sent in as few chunks as possible. 5. Stack can now receive files and chunks with ?unlimited? size. Old stack wrote the incoming data to memory and did not utilize disk space until the end of chunk was reached (large chunks from another client crashed it). 6. Now when writing the incoming data to file, it will take into account the byte-range header values. So, this complies with the RFC4975 requirements that stack must be able to handle chunks that come in any sequence. 7. Some buffering changes to outgoing/incoming data. 8. The outgoing data is now checked that it does not contain the created transaction-id before sending the data. 9. MSRP success reports are now implemented and tested against servers. 10. Progress report system fixed so progress is now visible on client (all the way to 100%). 11. Message Cancel receiving / Cancel sending now corrected and made to work as rfc4975 requires. (termination from sender and error code from receiver when cancelling). 12. Bug correction related to messages received not belonging to any session, old stack implementation did send error response, but after response was written it did give the buffer to client anyway. Now corrected.

/*
* Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html."
* Initial Contributors:
* Nokia Corporation - initial contribution.
* Contributors:
*
* Description:
* MSRP Implementation
*
*/

#ifndef CMSRPMSGPARSER_H_
#define CMSRPMSGPARSER_H_

#ifdef UT_TEST
#include "../../tsrc/conn_parser/inc/CMSRPMessageHandler.h"
#else
#include "CMSRPMessageHandler.h"
#endif

#include "MMSRPParserObserver.h"
#include "MSRPBuffer.h"

#define MSRP_COLON ':'
#define MSRP_SPACE ' '
#define MSRP_CARRIAGE '\r'
#define MSRP_TERMINATE  '#'
#define MSRP_CONTINUE  '+'
#define MSRP_END  '$'

#define KMSRPIDLenMax 32
#define KMSRPIDLenMin 4
#define KMSRPEndTokenMax KMSRPIDLenMax+8+2 //init-crlf

class CMSRPMsgParser: public CBase
    {
    friend class CMSRPParser;    
    public:
        enum TParseState 
            {
            EIdle = 0,
            ETitleLine,
            EToPath,
            EFromPath,
            //EMandatoryHeader,
            EOptionalHeaders,
            EBody,
            EExtraCRLF,        
            EEndofEndLine
            };
            
        enum TMatchType
            {
            ENoMatch,
            EFullMatch,        
            EPartialMatch   
            };
        
        static CMSRPMsgParser* NewL(MMSRPParserObserver& aConnection);
        virtual ~CMSRPMsgParser();
        
        TBool ParseL();
    
    private:
        CMSRPMsgParser(MMSRPParserObserver& aConnection);
        void ConstructL();
        
        TBool HandleFullMatchL(TPtrC8& aToken, TInt aMatchPos, TBool aCopyToLocal = FALSE);
        TBool HandlePartialMatchL(TPtrC8& aToken, TInt aCurBufMatchPos);
        TBool HandleNoMatchL(TPtrC8& aToken, TInt aCurBufMatchPos);
        
        void HandleStateL(const TDesC8& aString, TInt aMatchPos);
        void HandleTitleLineL(const TDesC8& aString, TInt aMatchPos);
        void HandleHeaderL(const TDesC8& aString, TInt aMatchPos);
        void HandleOptionalHeaderL(const TDesC8& aString, TInt aMatchPos);
        void HandleBodyL(const TDesC8& aString, TInt aMatchPos);
        void HandleXtraCrlfL(const TDesC8& aString, TInt aMatchPos);
        void HandleEndofEndLineL(const TDesC8& aString, TInt aMatchPos);
            
        TMatchType FindToken(const TDesC8& aString, const TDesC8& aToken, TInt& aMatchPos);
        
        /**
        * Check if this chunk belongs to one of messages received 
        * earlier. If so, the messages are combined to one
        * entity
        */
        void CheckMessageChunkL( );
    
    private:
    
        MMSRPParserObserver& iConnection;
        RPointerArray<RMsrpBuf> iParseBuffers;
        TParseState iState;
        RMsrpBuf* iLocalBuf;//keep it above pool
        CMSRPMessageHandler* iMessage;
        CMSRPBufPool iBufPool;
        HBufC8* iEndToken;
        
        // byte-range header included indicator
        TBool iByteRangeHeaderFound;
        
        // pool of incoming message chunks. This array contains unfinished 
        // message chunks which are waiting for the next chunk to arrive
        RPointerArray< CMSRPMessageHandler > iIncomingMessageChunks;
    };
#endif /* CMSRPMSGPARSER_H_ */