PECengine/PresenceServer2/ServerSrc/CPEngHandlerLogIn.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     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 in Handler
       
    15 * 				 Handles Log in for opening of the network session
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __CPENGHANDLERLOGIN_H__
       
    22 #define __CPENGHANDLERLOGIN_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 /**
       
    39  *  Log in Handler
       
    40  *  Handles Log in for opening of the network session
       
    41  *
       
    42  *  @lib PEngServer2
       
    43  *  @since 3.0
       
    44  */
       
    45 NONSHARABLE_CLASS( CPEngHandlerLogIn ) :
       
    46         public CActive,
       
    47         public MPEngRequestHandler
       
    48     {
       
    49 public:  // Constructors and destructor
       
    50 
       
    51     /**
       
    52      * Two-phased constructor.
       
    53      * @since 3.0
       
    54      * @param aObserver Request handler observer
       
    55      * @param aAccessHandler access handler
       
    56      * @param aSubSession sub session
       
    57      * @param aMessage message to complete request to
       
    58      * @param aSessionId session id
       
    59      * @param aSubSessionId subsession id
       
    60      * @return Log in handler
       
    61      */
       
    62     static CPEngHandlerLogIn* NewL(
       
    63         MPEngRequestHandlerObserver& aObserver,
       
    64         MPEngAccessHandler& aAccessHandler,
       
    65         MPEngSubSession& aSubSession,
       
    66         const RPEngMessage& aMessage,
       
    67         TInt32 aSessionId,
       
    68         TInt32 aSubSessionId );
       
    69 
       
    70     static CPEngHandlerLogIn* NewLC(
       
    71         MPEngRequestHandlerObserver& aObserver,
       
    72         MPEngAccessHandler& aAccessHandler,
       
    73         MPEngSubSession& aSubSession,
       
    74         const RPEngMessage& aMessage,
       
    75         TInt32 aSessionId,
       
    76         TInt32 aSubSessionId );
       
    77 
       
    78     /**
       
    79      * Destructor.
       
    80      */
       
    81     virtual ~CPEngHandlerLogIn();
       
    82 
       
    83 public: // New Functions
       
    84 
       
    85     /**
       
    86      * Start Handling of the request
       
    87      *
       
    88      * @since 3.1
       
    89      * @param aMessage message of the request
       
    90      */
       
    91     void StartHandlerL( const RPEngMessage& aMessage );
       
    92 
       
    93 
       
    94 public: // Function from MPEngRequestHandler
       
    95 
       
    96     /**
       
    97      * Return Session Id
       
    98      * @see <MPEngRequestHandler.h>
       
    99      */
       
   100     TInt32 SessionId() const ;
       
   101 
       
   102     /**
       
   103      * Return Sub-Session Id
       
   104      * @see <MPEngRequestHandler.h>
       
   105      */
       
   106     TInt SubSessionId() const ;
       
   107 
       
   108     /**
       
   109      * Return Request function
       
   110      * @see <MPEngRequestHandler.h>
       
   111      */
       
   112     TInt RequestFunction() const;
       
   113 
       
   114     /**
       
   115      * Cancel Request
       
   116      * @see <MPEngRequestHandler.h>
       
   117      */
       
   118     void CancelRequestD();
       
   119 
       
   120     /**
       
   121      * Set message handler
       
   122      * @see <MPEngRequestHandler.h>
       
   123      */
       
   124     void SetMessage( const RPEngMessage& aMessage );
       
   125 
       
   126 public:		// Function from the CActive
       
   127     /**
       
   128      * CActive RunL()
       
   129      * @since 3.0
       
   130      */
       
   131     void RunL();
       
   132 
       
   133     /**
       
   134      * CActive RunError()
       
   135      * @since 3.0
       
   136      */
       
   137     TInt RunError( TInt aError );
       
   138 
       
   139     /**
       
   140      * Implements cancellation of an outstanding request.
       
   141      * @since 3.0
       
   142      */
       
   143     void DoCancel();
       
   144 
       
   145 private:
       
   146 
       
   147     /**
       
   148      * C++ default constructor.
       
   149      */
       
   150     CPEngHandlerLogIn(
       
   151         MPEngRequestHandlerObserver& aObserver,
       
   152         MPEngAccessHandler& aAccessHandler,
       
   153         MPEngSubSession& aSubSession,
       
   154         const RPEngMessage& aMessage,
       
   155         TInt32 aSessionId,
       
   156         TInt32 aSubSessionId );
       
   157 
       
   158     /**
       
   159      * By default Symbian 2nd phase constructor is private.
       
   160      */
       
   161     void ConstructL();
       
   162 
       
   163 private:    // Data
       
   164     /// OWN: Request RPEngMessage
       
   165     RPEngMessage						iMessage;
       
   166 
       
   167     /// OWN: Server Session Id from where request came
       
   168     TInt32								iSessionId;
       
   169 
       
   170     /// OWN: Server Sub session Id from where request came
       
   171     TInt								iSubSessionId;
       
   172 
       
   173     /// OWN: Request Function
       
   174     TInt								iFunction;
       
   175 
       
   176     /// REF: Access handler
       
   177     MPEngAccessHandler&					iAccessHandler;
       
   178 
       
   179     /// REF: Request Handler Observer
       
   180     MPEngRequestHandlerObserver&		iObserver;
       
   181 
       
   182     /// REF: Sub-session from which request came
       
   183     MPEngSubSession&					iSubSession;
       
   184 
       
   185     };
       
   186 
       
   187 #endif      // __CPENGHANDLERLOGIN_H__
       
   188 
       
   189 // End of File