1 /*

     2 * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : SigCompCompartmentContext.h

    16 * Part of     : SigComp / compartment

    17 * Interface   : 

    18 * sigcomp compartment external interface

    19 * Version     : 1.0

    20 *

    21 */

    22 

    23 

    24 

    25 #ifndef MSIGCOMPCOMPARTMENTCONTEXT_H

    26 #define MSIGCOMPCOMPARTMENTCONTEXT_H

    27 

    28 //  INCLUDES

    29 #include <e32base.h>

    30 

    31 // FORWARD DECLARATIONS

    32 class CSigCompCompressionContext;

    33 

    34 // CLASS DECLARATION

    35 /**

    36 * @publishedPartner

    37 * @released

    38 *

    39 *  Compartment interface.

    40 *  

    41 *  @lib sigcomp

    42 */

    43 class MSigCompCompartmentContext

    44     {

    45     public:

    46         /**

    47          * Gets returned feedback from compartment

    48          * 

    49          * @return returned feedback

    50          */

    51         virtual const TDesC8& ReturnedFeedback() const = 0;

    52 

    53         /**

    54          * Gets requested feedback from compartment

    55          * 

    56          * @return requested feedback

    57          */

    58         virtual const TDesC8& RequestedFeedback() const = 0;

    59 

    60         /**

    61          * Set returned feedback in compartment

    62          * Internal use only

    63          * Can leave if system resourcess missing (no memory for egz.)

    64          *

    65          * @param aReturnedFeedback a returned feedback

    66          */

    67         virtual void SetReturnedFeedbackL(const TDesC8& aReturnedFeedback) = 0;

    68 

    69         /**

    70          * Set requested feedback in compartment

    71          * Internal use only

    72          * Can leave if system resourcess missing (no memory for egz.)

    73          *

    74          * @param aRequestedFeedback a requested feedback

    75          */

    76         virtual void SetRequestedFeedbackL(const TDesC8& aRequestedFeedback) = 0;

    77 

    78         /**

    79          * Gets returned parameters from compartment

    80          * 

    81          * @return returned parameters

    82          */

    83         virtual const TDesC8& ReturnedParameters() const = 0;

    84 

    85         /**

    86          * Gets compression context from compartment

    87          * 

    88          * @return compression context

    89          */

    90         virtual const CSigCompCompressionContext*

    91                                         CompressionContext() const = 0;

    92 

    93         /**

    94          * Sets compression context in compartment

    95          * 

    96          * @param aContext compression context to be saved in compartment.

    97          * 

    98          */

    99         virtual void SetCompressionContext(

   100                             CSigCompCompressionContext* aContext) = 0;

   101 

   102         /**

   103          * Gets type of compression (dynamic or not)

   104          * 

   105          * @return ETrue for dynamic compression, EFalse for static).

   106          */

   107         virtual TBool IsDynamicCompression() const = 0;

   108         

   109         /**

   110          * Gets cycles per bit

   111          * 

   112          * @return Cycles per bit

   113          */

   114         virtual CSigComp::TCyclesPerBit CyclesPerBit() const = 0;

   115 

   116         /**

   117          * Gets decompression memory size

   118          * 

   119          * @return Decompression memory size

   120          */

   121         virtual CSigComp::TMemorySize DecompressionMemorySize() const = 0;

   122 

   123         /**

   124          * Gets state memory size

   125          * 

   126          * @return State memory size

   127          */

   128         virtual CSigComp::TMemorySize StateMemorySize() const = 0;

   129     };

   130 

   131 #endif // MSIGCOMPCOMPARTMENTCONTEXT_H

   132             

   133 // End of File