multimediacommsengine/mmcesrv/mmceevent/inc/mceeventstatebase.h
changeset 0 1bce908db942
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     1 /*
       
     2 * Copyright (c) 2005 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:    Abstract base class for event states.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 #ifndef CMCEEVENTSTATEBASE_H
       
    23 #define CMCEEVENTSTATEBASE_H
       
    24 
       
    25 // INCLUDES
       
    26 #include <e32base.h>
       
    27 #include "mcecomevent.h"
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class CMceComEvent;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35 *  Abstract base class for event states. Virtual methods are implemented
       
    36 *  in concrete states,
       
    37 *
       
    38 *  @lib 
       
    39 *  @since
       
    40 */
       
    41 class CMceEventStateBase : public CBase 
       
    42     {
       
    43     public:  // Constructors and destructor
       
    44         
       
    45         /**
       
    46         * Destructor.
       
    47         */
       
    48         ~CMceEventStateBase();
       
    49 
       
    50     public: // New functions
       
    51       
       
    52         /**
       
    53         * Handle client initiated actions. Leaves on error.
       
    54         * @param aEvent, a reference to CMceComEvent
       
    55         * @return None
       
    56         */
       
    57         void ProcessStateL( CMceComEvent& aEvent );
       
    58 
       
    59         /**
       
    60         * Handle request received from the SIP stack. Leaves on error.
       
    61         * @param aEvent, a reference to CMceComEvent
       
    62         * @return None
       
    63         */
       
    64         void ProcessReqRecvStateL( CMceComEvent& aEvent );
       
    65         
       
    66         /**
       
    67         * Handle response or error received from the SIP stack. 
       
    68         * Leaves on error.
       
    69         * @param aEvent, a reference to CMceComEvent
       
    70         * @return None
       
    71         */
       
    72         void ProcessRespRecvStateL( CMceComEvent& aEvent );
       
    73  
       
    74     protected:  // New functions
       
    75         
       
    76         /**
       
    77         * Handle client initiated actions. Leaves on error.
       
    78         * Implemented in concrete states.
       
    79         * @param aEvent, a reference to CMceComEvent
       
    80         * @return None
       
    81         */
       
    82         virtual void HandleL( CMceComEvent& aEvent ) = 0;
       
    83         
       
    84         /**
       
    85         * Handle request received from the SIP stack. Leaves on error.
       
    86         * Implemented in concrete states.
       
    87         * @param aEvent, a reference to CMceComEvent
       
    88         */
       
    89         virtual void HandleReceiveRequestL( CMceComEvent& aEvent ) = 0;
       
    90         
       
    91         /**
       
    92         * Handle response or error received from the SIP stack. 
       
    93         * Leaves on error. Implemented in concrete states.
       
    94         * @param aEvent, a reference to CMceComEvent
       
    95         */
       
    96         virtual void HandleResponseReceivedL( CMceComEvent& aEvent ) = 0;
       
    97 
       
    98         /**
       
    99         * C++ default constructor.
       
   100         */
       
   101         CMceEventStateBase();
       
   102         
       
   103     private://EUNIT
       
   104     
       
   105     	friend class UT_CMceEventStateBase;
       
   106         
       
   107     };
       
   108 
       
   109 #endif      // CMCEEVENTSTATEBASE_H
       
   110             
       
   111 // End of File