1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/featuremgmt/featuremgr/src/serverexe/featmgrsession.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,196 @@
1.4 +/*
1.5 +* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +
1.24 +#ifndef FEATMGRSESSION_H
1.25 +#define FEATMGRSESSION_H
1.26 +
1.27 +// INCLUDES
1.28 +#include <e32base.h>
1.29 +#include "featmgrclientserver.h"
1.30 +#include "featmgrserver.h"
1.31 +
1.32 +// FORWARD DECLARATIONS
1.33 +class CFeatMgrFeatureRegistry;
1.34 +
1.35 +// CLASS DECLARATION
1.36 +
1.37 +/**
1.38 +* Contains pending request if feature info is not ready.
1.39 +*/
1.40 +NONSHARABLE_CLASS(CFeatMgrPendingRequest) : public CBase
1.41 + {
1.42 + public:
1.43 + /**
1.44 + * Two-phased constructor.
1.45 + */
1.46 + static CFeatMgrPendingRequest* NewL(const RMessage2& aMessage);
1.47 +
1.48 + /**
1.49 + * Destructor.
1.50 + */
1.51 + virtual ~CFeatMgrPendingRequest();
1.52 +
1.53 + private:
1.54 + /**
1.55 + * C++ default constructor.
1.56 + */
1.57 + CFeatMgrPendingRequest();
1.58 +
1.59 + /**
1.60 + * ConstructL
1.61 + */
1.62 + void ConstructL(const RMessage2& aMessage);
1.63 +
1.64 + public: // data
1.65 +
1.66 + // The offset of a component link object within elements that form the list.
1.67 + static const TInt iOffset;
1.68 +
1.69 + // Message for later completion is stored here.
1.70 + RMessage2 iMessage;
1.71 +
1.72 + private: // data
1.73 +
1.74 + // A link object encapsulates a pointer to the next link object in the list.
1.75 + TSglQueLink iLink;
1.76 +
1.77 + };
1.78 +
1.79 +
1.80 +// CLASS DECLARATION
1.81 +
1.82 +/**
1.83 +* Represents a session for a client thread on the server-side.
1.84 +* A session acts as a channel of communication between the client
1.85 +* and the server.
1.86 +*
1.87 +*/
1.88 +NONSHARABLE_CLASS(CFeatMgrSession) : public CSession2
1.89 + {
1.90 + public: // Constructors and destructor
1.91 +
1.92 + /**
1.93 + * Two-phased constructor.
1.94 + */
1.95 + static CFeatMgrSession* NewL(CFeatMgrServer& aServer, CFeatMgrFeatureRegistry& aRegistry);
1.96 +
1.97 + /**
1.98 + * Destructor.
1.99 + */
1.100 + virtual ~CFeatMgrSession();
1.101 +
1.102 +#ifdef EXTENDED_FEATURE_MANAGER_TEST
1.103 + /**
1.104 + * 2nd phase construct for sessions - called by the CServer framework
1.105 + */
1.106 + void CreateL();
1.107 +#endif // EXTENDED_FEATURE_MANAGER_TEST
1.108 +
1.109 +
1.110 + public: // New functions
1.111 +
1.112 + /**
1.113 + * Called by the server when feature info is ready.
1.114 + * Calls request handling functions for pending requests.
1.115 + */
1.116 + void ServicePendingRequestsL();
1.117 +
1.118 + /**
1.119 + * Called by the server when existing feature has changed or new one added.
1.120 + * Completes client notification requests if such exist for feature changed.
1.121 + */
1.122 + void ServiceNotifications( TFeatureServerEntry& aFeature, TFeatureChangeType aType );
1.123 +
1.124 + /**
1.125 + * Panics client thread.
1.126 + *
1.127 + * @param aMessage Message that is being handled
1.128 + * @param aPanic Panic type
1.129 + */
1.130 + static void PanicClient( const RMessage2& aMessage, TFeatMgrPanic aPanic );
1.131 +
1.132 +
1.133 + public: // Functions from base classes
1.134 +
1.135 + protected: // New functions
1.136 +
1.137 + protected: // Functions from base classes
1.138 +
1.139 + /**
1.140 + * From CSession2
1.141 + *
1.142 + * @param aMessage The message containing the client request
1.143 + */
1.144 + virtual void ServiceL( const RMessage2& aMessage );
1.145 + virtual TInt CountResources();
1.146 +
1.147 + private:
1.148 +
1.149 + /**
1.150 + * C++ default constructor.
1.151 + */
1.152 + CFeatMgrSession(CFeatMgrServer& aServer, CFeatMgrFeatureRegistry& aRegistry);
1.153 +
1.154 + /**
1.155 + * By default Symbian 2nd phase constructor is private.
1.156 + */
1.157 + void ConstructL();
1.158 +
1.159 + /**
1.160 + * Calls matching function of CFeatMgrServer for handling the request.
1.161 + *
1.162 + * @param aMessage The message containing the client request
1.163 + */
1.164 + void DispatchMessageL( const RMessage2& aMessage );
1.165 +
1.166 + TBool IsWriteOperation( const TInt aFunction ) const;
1.167 +
1.168 + private: // Data
1.169 +
1.170 + /**
1.171 + * Feature Manager server reference.
1.172 + */
1.173 + CFeatMgrServer& iFeatMgrServer;
1.174 +
1.175 + /**
1.176 + * Feature Manager feature handler reference.
1.177 + */
1.178 + CFeatMgrFeatureRegistry& iRegistry;
1.179 +
1.180 + /**
1.181 + * Linked list of CFeatMgrPendingRequest objects.
1.182 + */
1.183 + TSglQue<CFeatMgrPendingRequest> iList;
1.184 +
1.185 + /**
1.186 + * Array of IDs of supported features.
1.187 + */
1.188 + RFeatureUidArray iNotifyFeatures;
1.189 +
1.190 + /**
1.191 + * Request-message used for signaling client.
1.192 + */
1.193 + RMessagePtr2 iNotifyMessage;
1.194 +
1.195 + };
1.196 +
1.197 +#endif // FEATMGRSESSION_H
1.198 +
1.199 +// End of File