Symbian^3 Application Developer Library >

CAlfAppSrvSessionBase Class Reference

class CAlfAppSrvSessionBase : public CAknAppServiceBase

Session/service class in the server side.

Since
S60 v3.2

Inherits from

Public Member Functions
CAlfAppSrvSessionBase (const CAlfAppServer *)
CAlfAppSrvSessionBase ()
~CAlfAppSrvSessionBase ()
void ActivateContainerLayoutL ( TBool )
IMPORT_C CAlfAppUi * AlfAppUi ()
IMPORT_C void AlfInterfaceProviderExtension (const TUid &, TAny **)
IMPORT_C CAlfAppServer * AlfServer ()
void CancelPointerEvents ()
void CancelSystemEvents ()
IMPORT_C TRect ClientDrawingArea ()
TInt ClientWindowGroup ()
void CloseSubSession (const RMessage2 &)
IMPORT_C void CompleteCmd ( TInt , TInt )
CAlfClientMessage * CreateNewMessageHolderL (const RMessage2 &)
void DoHandleCommandL (const RMessage2 &)
IMPORT_C void ExtensionInterfaceL ( TUid , TAny *&)
IMPORT_C void FactoryDestroyed ( TInt )
void FlushPointerHandling ()
IMPORT_C void FocusGainedL ( TBool )
IMPORT_C TBool FocusLostL ( TBool )
IMPORT_C TInt GetHandleFromInterface (const THuiInterfaceSupport &, TAny *)
IMPORT_C TAny * GetInterfaceL (const THuiInterfaceSupport &, TInt )
void GetSubsessionsByTypeL ( RPointerArray < CAlfSrvSubSessionBase > &, const THuiInterfaceSupport &)
void GetSystemEvents (const RMessage2 *)
IMPORT_C TInt HandleCurrentCommanndAsynch ()
void HandleEventL ( TAny *, TAny *, const THuiEvent &)
TBool HasSession ( TInt )
IMPORT_C CAlfLayoutManager * LayoutManager ()
TInt ParentWindowGroupId ()
IMPORT_C THuiRefreshMode PreferredRefreshMode ()
IMPORT_C CAlfAppServer::TAlfWGPostion PreferredWindowGroupPosition ()
void ResetRootlayerTransformationsL ()
void SetBackgroundMaxFps ( TBool )
IMPORT_C void SetClientWindowGroupId ( TInt )
void SetParentWindowGroupId ( TInt )
IMPORT_C CHuiEnv * SharedHuiEnv ()
void StartPointerHandling ()
CAlfSrvSubSessionBase & SubSession ( TInt )
void TriggerPointerEvent (const RMessage2 *)
void TriggerSystemEvent ( TInt )
Protected Member Functions
IMPORT_C void BaseConstructL ()
IMPORT_C TInt CountResources ()
CAlfSrvSubSessionBase * CreateSubSessionLC (const RMessage2 &)
IMPORT_C void Disconnect (const RMessage2 &)
IMPORT_C TInt Extension_ ( TUint , TAny *&, TAny *)
TBool IsSubSessionCreationFunction (const RMessage2 &)
IMPORT_C void ServiceError (const RMessage2 &, TInt )
Private Member Functions
void CloseSubSession ( TInt )
TBool DoSubSessionCmdL (const RMessage2 &)
IMPORT_C void ServiceL (const RMessage2 &)
Inherited Functions
CAknAppServiceBase::CAknAppServiceBase()
CAknAppServiceBase::CreateL()
CAknAppServiceBase::~CAknAppServiceBase()
CApaAppServiceBase::CApaAppServiceBase()
CApaAppServiceBase::SecurityCheckL(const RMessage2 &,TInt &,TSecurityInfo &)
CApaAppServiceBase::SendAppServerExitNotification(TInt)
CApaAppServiceBase::~CApaAppServiceBase()
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CSession2::CSession2()
CSession2::ResourceCountMarkEnd(const RMessage2 &)
CSession2::ResourceCountMarkStart()
CSession2::Server()const
CSession2::SetServer(const CServer2 *)
CSession2::~CSession2()
Inherited Enumerations
CSession2:TPanicNo
Private Attributes
TPrivateData * iData
CAlfAppServer * iHost

Constructor & Destructor Documentation

CAlfAppSrvSessionBase(const CAlfAppServer *)

IMPORT_C CAlfAppSrvSessionBase ( const CAlfAppServer * aServer )

Default constructor, stores pointer to server instance

Parameters

const CAlfAppServer * aServer Server which the client has connected.

CAlfAppSrvSessionBase()

IMPORT_C CAlfAppSrvSessionBase ( )

Default constructor, fetches and stores pointer to server instance using ccoestatic

~CAlfAppSrvSessionBase()

IMPORT_C ~CAlfAppSrvSessionBase ( )

Destructor, singals server to free resources specific for this client

Member Functions Documentation

ActivateContainerLayoutL(TBool)

void ActivateContainerLayoutL ( TBool aActivate )

Parameters

TBool aActivate

AlfAppUi()

IMPORT_C CAlfAppUi * AlfAppUi ( )

AlfInterfaceProviderExtension(const TUid &, TAny **)

IMPORT_C void AlfInterfaceProviderExtension ( const TUid & aExtensionUid,
TAny ** aExtensionParams
)

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

AlfServer()

IMPORT_C CAlfAppServer * AlfServer ( )

BaseConstructL()

IMPORT_C void BaseConstructL ( ) [protected]

CancelPointerEvents()

void CancelPointerEvents ( )

CancelSystemEvents()

void CancelSystemEvents ( )

ClientDrawingArea()

IMPORT_C TRect ClientDrawingArea ( ) const [virtual]

Gets the drawing area of the session

ClientWindowGroup()

TInt ClientWindowGroup ( ) const

From CAlfAppSrvSessionBase Returns the client's window group id.

CloseSubSession(const RMessage2 &)

void CloseSubSession ( const RMessage2 & aMessage )

Parameters

const RMessage2 & aMessage

CloseSubSession(TInt)

void CloseSubSession ( TInt aHandle ) [private]

Parameters

TInt aHandle

CompleteCmd(TInt, TInt)

IMPORT_C void CompleteCmd ( TInt aCommadIdentifier,
TInt aResult
)

Parameters

TInt aCommadIdentifier
TInt aResult

CountResources()

IMPORT_C TInt CountResources ( ) [protected, virtual]

CreateNewMessageHolderL(const RMessage2 &)

CAlfClientMessage * CreateNewMessageHolderL ( const RMessage2 & aMessage )

Parameters

const RMessage2 & aMessage

CreateSubSessionLC(const RMessage2 &)

CAlfSrvSubSessionBase * CreateSubSessionLC ( const RMessage2 & aMessage ) [protected]

Parameters

const RMessage2 & aMessage

Disconnect(const RMessage2 &)

IMPORT_C void Disconnect ( const RMessage2 & aMessage ) [protected, virtual]

Parameters

const RMessage2 & aMessage

DoHandleCommandL(const RMessage2 &)

void DoHandleCommandL ( const RMessage2 & aMessage ) [pure virtual]

From CAlfAppSrvSessionBase Called when a message is received from the client.

Parameters

const RMessage2 & aMessage Message parameters.

DoSubSessionCmdL(const RMessage2 &)

TBool DoSubSessionCmdL ( const RMessage2 & aMessage ) [private]

Parameters

const RMessage2 & aMessage

ExtensionInterfaceL(TUid, TAny *&)

IMPORT_C void ExtensionInterfaceL ( TUid aInterfaceId,
TAny *& aImplementation
) [virtual]

Parameters

TUid aInterfaceId
TAny *& aImplementation

Extension_(TUint, TAny *&, TAny *)

IMPORT_C TInt Extension_ ( TUint aExtensionId,
TAny *& a0,
TAny * a1
) [protected, virtual]

! CSession2

Parameters

TUint aExtensionId
TAny *& a0
TAny * a1

FactoryDestroyed(TInt)

IMPORT_C void FactoryDestroyed ( TInt aFactoryUid ) [virtual]

Ecom implementation for specific factory has been removed Close all subsessions referring to that

Parameters

TInt aFactoryUid

FlushPointerHandling()

void FlushPointerHandling ( )

FocusGainedL(TBool)

IMPORT_C void FocusGainedL ( TBool aDoTransitionEffect ) [virtual]

From CAlfAppSrvSessionBase Client's window group received focus.

Parameters

TBool aDoTransitionEffect Do fade in transision (RnD)

FocusLostL(TBool)

IMPORT_C TBool FocusLostL ( TBool aDoTransitionEffect ) [virtual]

From CAlfAppSrvSessionBase Client's window group lost focus.

Parameters

TBool aDoTransitionEffect Do fade out transision (RnD)

GetHandleFromInterface(const THuiInterfaceSupport &, TAny *)

IMPORT_C TInt GetHandleFromInterface ( const THuiInterfaceSupport & aType,
TAny * aInterface
)

Parameters

const THuiInterfaceSupport & aType
TAny * aInterface

GetInterfaceL(const THuiInterfaceSupport &, TInt)

IMPORT_C TAny * GetInterfaceL ( const THuiInterfaceSupport & aType,
TInt aHandle
)

Parameters

const THuiInterfaceSupport & aType
TInt aHandle

GetSubsessionsByTypeL(RPointerArray< CAlfSrvSubSessionBase > &, const THuiInterfaceSupport &)

void GetSubsessionsByTypeL ( RPointerArray < CAlfSrvSubSessionBase > & aArray,
const THuiInterfaceSupport & aType
)

Finds all the subsession which implement the interface.

Parameters

RPointerArray < CAlfSrvSubSessionBase > & aArray Array which the function fills of subsession on return.
const THuiInterfaceSupport & aType Type of the interface that we are looking for.

GetSystemEvents(const RMessage2 *)

void GetSystemEvents ( const RMessage2 * aMessage )

Parameters

const RMessage2 * aMessage

HandleCurrentCommanndAsynch()

IMPORT_C TInt HandleCurrentCommanndAsynch ( )

HandleEventL(TAny *, TAny *, const THuiEvent &)

void HandleEventL ( TAny * aCtrlPtr,
TAny * aVisualPtr,
const THuiEvent & aEvent
)

Parameters

TAny * aCtrlPtr
TAny * aVisualPtr
const THuiEvent & aEvent

HasSession(TInt)

TBool HasSession ( TInt aSubSessionHandle ) const

Returns ETrue if this session owns specified subsession handle.

Parameters

TInt aSubSessionHandle

IsSubSessionCreationFunction(const RMessage2 &)

TBool IsSubSessionCreationFunction ( const RMessage2 & aMessage ) const [protected]

Parameters

const RMessage2 & aMessage

LayoutManager()

IMPORT_C CAlfLayoutManager * LayoutManager ( ) const

ParentWindowGroupId()

TInt ParentWindowGroupId ( )

PreferredRefreshMode()

IMPORT_C THuiRefreshMode PreferredRefreshMode ( ) const [virtual]

Returns the preferred refresh mode of the session.

PreferredWindowGroupPosition()

IMPORT_C CAlfAppServer::TAlfWGPostion PreferredWindowGroupPosition ( ) const [virtual]

Returns the preferred window group position of the session.

ResetRootlayerTransformationsL()

void ResetRootlayerTransformationsL ( )

ServiceError(const RMessage2 &, TInt)

IMPORT_C void ServiceError ( const RMessage2 & aMessage,
TInt aError
) [protected, virtual]

Override of CSession2::ServiceError() . If further overridden, this function must be base-called.

Parameters

const RMessage2 & aMessage The client message.
TInt aError The error code to which occured during message servicing

ServiceL(const RMessage2 &)

IMPORT_C void ServiceL ( const RMessage2 & aMessage ) [private, virtual]

From CAknAppServiceBase . Called by the framework when a client requests a sevice.

Parameters

const RMessage2 & aMessage Client's message.

SetBackgroundMaxFps(TBool)

void SetBackgroundMaxFps ( TBool ) [inline, virtual]

Sets session's max fps limiter to half, used if client's window does not have keyboard focus

Parameters

TBool

SetClientWindowGroupId(TInt)

IMPORT_C void SetClientWindowGroupId ( TInt aId )

Sets the window group ID. Server uses this information to calculate its screen position in Symbian window tree

Parameters

TInt aId Wg ID

SetParentWindowGroupId(TInt)

void SetParentWindowGroupId ( TInt aParentId )

Parameters

TInt aParentId

SharedHuiEnv()

IMPORT_C CHuiEnv * SharedHuiEnv ( ) const

StartPointerHandling()

void StartPointerHandling ( )

SubSession(TInt)

CAlfSrvSubSessionBase & SubSession ( TInt aSubSessionHandle )

Parameters

TInt aSubSessionHandle

TriggerPointerEvent(const RMessage2 *)

void TriggerPointerEvent ( const RMessage2 * aMessage )

Parameters

const RMessage2 * aMessage

TriggerSystemEvent(TInt)

void TriggerSystemEvent ( TInt aEvent )

Parameters

TInt aEvent

Member Data Documentation

TPrivateData * iData

TPrivateData * iData [private]

CAlfAppServer * iHost

CAlfAppServer * iHost [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.