1 /*

     2 * Copyright (c) 2002 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:  Log out Handler

    15 *			     Handles Log in for closing of the network session

    16 *

    17 */

    18 

    19 

    20 

    21 #ifndef __CPENGHANDLERLOGOFF_H__

    22 #define __CPENGHANDLERLOGOFF_H__

    23 

    24 //  INCLUDES

    25 #include <e32base.h>

    26 #include "MPEngRequestHandler.h"

    27 

    28 //	Own RMessage class wraper

    29 #include "RPEngMessage.h"

    30 

    31 // FORWARD DECLARATIONS

    32 class MPEngRequestHandlerObserver;

    33 class MPEngAccessHandler;

    34 class MPEngSubSession;

    35 

    36 // CLASS DECLARATION

    37 /**

    38  *  Log out Handler

    39  *  Handles Log in for closing of the network session

    40  *

    41  *  @lib PEngServer2

    42  *  @since 3.0

    43  */

    44 NONSHARABLE_CLASS( CPEngHandlerLogOff ) :

    45         public CActive,

    46         public MPEngRequestHandler

    47     {

    48 public:  // Constructors and destructor

    49 

    50     /**

    51      * Two-phased constructor.

    52      * @since 3.0

    53      * @param aObserver Request handler observer

    54      * @param aAccessHandler access handler

    55      * @param aSubSession sub session

    56      * @param aMessage message to complete request to

    57      * @param aSessionId session id

    58      * @param aSubSessionId subsession id

    59      * @return Log out handler

    60      */

    61     static CPEngHandlerLogOff* NewL(

    62         MPEngRequestHandlerObserver& aObserver,

    63         MPEngAccessHandler& aAccessHandler,

    64         MPEngSubSession& aSubSession,

    65         const RPEngMessage& aMessage,

    66         TInt32 aSessionId,

    67         TInt32 aSubSessionId );

    68 

    69     static CPEngHandlerLogOff* NewLC(

    70         MPEngRequestHandlerObserver& aObserver,

    71         MPEngAccessHandler& aAccessHandler,

    72         MPEngSubSession& aSubSession,

    73         const RPEngMessage& aMessage,

    74         TInt32 aSessionId,

    75         TInt32 aSubSessionId );

    76 

    77     /**

    78      * Destructor.

    79      */

    80     virtual ~CPEngHandlerLogOff();

    81 

    82 public: // Function from MPEngRequestHandler

    83 

    84     /**

    85      * Start Handling of the request

    86      * @see <MPEngRequestHandler.h>

    87      */

    88     void StartHandlerL();

    89 

    90     /**

    91      * Return Session Id

    92      * @see <MPEngRequestHandler.h>

    93      */

    94     TInt32 SessionId() const ;

    95 

    96     /**

    97      * Return Sub-Session Id

    98      * @see <MPEngRequestHandler.h>

    99      */

   100     TInt SubSessionId() const ;

   101 

   102     /**

   103      * Return Request function

   104      * @see <MPEngRequestHandler.h>

   105      */

   106     TInt RequestFunction() const;

   107 

   108     /**

   109      * Cancel Request

   110      * @see <MPEngRequestHandler.h>

   111      */

   112     void CancelRequestD();

   113 

   114     /**

   115      * Set message handler

   116      * @see <MPEngRequestHandler.h>

   117      */

   118     void SetMessage( const RPEngMessage& aMessage );

   119 

   120 public:		// Function from the CActive

   121     /**

   122      * CActive RunL()

   123      * @since 3.0

   124      */

   125     void RunL();

   126 

   127     /**

   128      * CActive RunError()

   129      * @since 3.0

   130      */

   131     TInt RunError( TInt aError );

   132 

   133     /**

   134      * Implements cancellation of an outstanding request.

   135      * @since 3.0

   136      */

   137     void DoCancel();

   138 

   139 private:

   140 

   141     /**

   142      * C++ default constructor.

   143      */

   144     CPEngHandlerLogOff( MPEngRequestHandlerObserver& aObserver,

   145                         MPEngAccessHandler& aAccessHandler,

   146                         MPEngSubSession& aSubSession,

   147                         const RPEngMessage& aMessage,

   148                         TInt32 aSessionId,

   149                         TInt32 aSubSessionId );

   150 

   151     /**

   152      * By default Symbian 2nd phase constructor is private.

   153      */

   154     void ConstructL();

   155 

   156 private:    // Data

   157 

   158     /// OWN: Request RPEngMessage

   159     RPEngMessage						iMessage;

   160 

   161     /// OWN: Server Session Id from where request came

   162     TInt32								iSessionId;

   163 

   164     /// OWN: Server Sub session Id from where request came

   165     TInt								iSubSessionId;

   166 

   167     /// OWN: Request Function

   168     TInt								iFunction;

   169 

   170     /// REF: Access handler

   171     MPEngAccessHandler&					iAccessHandler;

   172 

   173     /// REF: Request Handler Observer

   174     MPEngRequestHandlerObserver&		iObserver;

   175 

   176     /// REF: Sub-session from which request came

   177     MPEngSubSession&					iSubSession;

   178     };

   179 

   180 #endif      // __CPENGHANDLERLOGOFF_H__

   181 

   182 // End of File