realtimenetprots/sipfw/SigComp/SigCompEngine/api/SigCompCompartmentContext.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 0 307788aac0a8
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) 2003-2009 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:
* Name        : SigCompCompartmentContext.h
* Part of     : SigComp / compartment
* Interface   : 
* sigcomp compartment external interface
* Version     : 1.0
*
*/



#ifndef MSIGCOMPCOMPARTMENTCONTEXT_H
#define MSIGCOMPCOMPARTMENTCONTEXT_H

//  INCLUDES
#include <e32base.h>

// FORWARD DECLARATIONS
class CSigCompCompressionContext;

// CLASS DECLARATION
/**
* @publishedPartner
* @released
*
*  Compartment interface.
*  
*  @lib sigcomp
*/
class MSigCompCompartmentContext
    {
    public:
        /**
         * Gets returned feedback from compartment
         * 
         * @return returned feedback
         */
        virtual const TDesC8& ReturnedFeedback() const = 0;

        /**
         * Gets requested feedback from compartment
         * 
         * @return requested feedback
         */
        virtual const TDesC8& RequestedFeedback() const = 0;

        /**
         * Set returned feedback in compartment
         * Internal use only
         * Can leave if system resourcess missing (no memory for egz.)
         *
         * @param aReturnedFeedback a returned feedback
         */
        virtual void SetReturnedFeedbackL(const TDesC8& aReturnedFeedback) = 0;

        /**
         * Set requested feedback in compartment
         * Internal use only
         * Can leave if system resourcess missing (no memory for egz.)
         *
         * @param aRequestedFeedback a requested feedback
         */
        virtual void SetRequestedFeedbackL(const TDesC8& aRequestedFeedback) = 0;

        /**
         * Gets returned parameters from compartment
         * 
         * @return returned parameters
         */
        virtual const TDesC8& ReturnedParameters() const = 0;

        /**
         * Gets compression context from compartment
         * 
         * @return compression context
         */
        virtual const CSigCompCompressionContext*
                                        CompressionContext() const = 0;

        /**
         * Sets compression context in compartment
         * 
         * @param aContext compression context to be saved in compartment.
         * 
         */
        virtual void SetCompressionContext(
                            CSigCompCompressionContext* aContext) = 0;

        /**
         * Gets type of compression (dynamic or not)
         * 
         * @return ETrue for dynamic compression, EFalse for static).
         */
        virtual TBool IsDynamicCompression() const = 0;
        
        /**
         * Gets cycles per bit
         * 
         * @return Cycles per bit
         */
        virtual CSigComp::TCyclesPerBit CyclesPerBit() const = 0;

        /**
         * Gets decompression memory size
         * 
         * @return Decompression memory size
         */
        virtual CSigComp::TMemorySize DecompressionMemorySize() const = 0;

        /**
         * Gets state memory size
         * 
         * @return State memory size
         */
        virtual CSigComp::TMemorySize StateMemorySize() const = 0;
    };

#endif // MSIGCOMPCOMPARTMENTCONTEXT_H
            
// End of File