CSession2 Class Reference

#include <e32base.h>

class CSession2 : public CBase

Inherits from

Public Member Enumerations
enumTPanicNo { ESesCountResourcesNotImplemented, ESesFoundResCountHeaven }
Public Member Functions
pure virtual ~CSession2()
virtual IMPORT_C TIntCountResources()
IMPORT_C voidResourceCountMarkEnd(const RMessage2 &)
IMPORT_C voidResourceCountMarkStart()
const CServer2 *Server()
virtual IMPORT_C voidServiceError(const RMessage2 &, TInt)
pure virtual voidServiceL(const RMessage2 &)
IMPORT_C voidSetServer(const CServer2 *)
Protected Member Functions
virtual IMPORT_C voidDisconnect(const RMessage2 &)
virtual IMPORT_C TIntExtension_(TUint, TAny *&, TAny *)
Inherited Functions
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)

Detailed Description

Represents a session (version 2) for a client thread on the server-side.

A session acts as a channel of communication between the client and the server. A client thread can have multiple concurrent sessions with a server.

A session can be:
  • restricted to the creating thread

  • can be shared with other threads in the same process

  • can be shared by all threads in the system.

A server must define and implement a derived class. In particular, it must provide an implementation for the ServiceL() virtual function.

(Note that this class should be used instead of CSession)

Member Enumeration Documentation

Enum TPanicNo

Constructor & Destructor Documentation

CSession2 ( )


Default constructor.

This constructor is empty.

~CSession2 ( )

IMPORT_C~CSession2()[pure virtual]


It frees resources prior to destruction of the object. Specifically, it removes this session object from the server active object s list of sessions.

Member Function Documentation

CountResources ( )

IMPORT_C TIntCountResources()[virtual]

Gets the number of resources currently in use.

Derived classes must provide a suitable implementation. The meaning of a resource depends on the design intent of the server.

The default implementation panics the calling thread (CSession 1) before returning KErrGeneral.

See also: CSession2::ResourceCountmarkStart() CSession2::ResourceCountmarkEnd()

Returns: The current number of resources in use.

Disconnect ( const RMessage2 & )

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

Called by a server when it receives a disconnect message for the session.

This message is sent by the kernel when all client handles to the session have been closed. This method deletes the session object and completes the disconnect message.

A derived session implementation may overide this virtual method if it needs to perform any asynchronous cleanup actions, these actions must end with a call to the base class implementation of this method, which will delete the session object and complete the disconnect message

'this' session object has been deleted.
aMessageThe disconnect message.

Extension_ ( TUint, TAny *&, TAny * )

IMPORT_C TIntExtension_(TUintaExtensionId,
TAny *&a0,
TAny *a1
)[protected, virtual]

Extension function

ResourceCountMarkEnd ( const RMessage2 & )

IMPORT_C voidResourceCountMarkEnd(const RMessage2 &aMessage)

Marks the end of resource count checking.

The function takes the current resource count by calling CSession2::CountResources(), and compares it with the resource count value saved when CSession2::ResourceCountMarkStart() was called. If the resource counts differ, then the client thread is panicked (CSession 2)".

The client/server framework does not call this function (nor does it call CSession2::ResourceCountMarkStart()), but the function is available for servers to use, if appropriate.

See also: CSession2::CountResources() CSession2::ResourceCountMarkStart()

aMessageRepresents the details of the client request that is requesting this resource check.

ResourceCountMarkStart ( )

IMPORT_C voidResourceCountMarkStart()

Marks the start of resource count checking.

It sets up a starting value for resource count checking.

The function sets up a starting value for resource count checking by using the value returned by a call to CSession2::CountResources(), and is the value that will be used for comparison if CSession2::ResourceCountMarkEnd() is called at some later time.

The client/server framework does not call this function (nor does it call CSession2::ResourceCountMarkEnd()), but is available for servers to use, if appropriate.

See also: CSession2::CountResources() CSession2::ResourceCountMarkEnd()

Server ( )

const CServer2 *Server()const [inline]

Gets the server active object that handles messages for this session.

This is the instance of the CServer2 derived class that created this session object.

Returns: The server active object.

ServiceError ( const RMessage2 &, TInt )

IMPORT_C voidServiceError(const RMessage2 &aMessage,

Handles the situation when a call to CSession2::ServiceL(), which services a client request, leaves.

Servers are active objects, and the call to CSession2::ServiceL() to handle a client request is executed as part of the server's active object RunL() function. If the RunL() leaves, the active object framework calls the active object's RunError() function. The server framework implements this as a call to ServiceError()

The default behaviour of this function is to complete the message, using the leave value, if it has not already been completed.

Servers can re-implement this as appropriate.

See also: CActive::RunL() CActive::RunError()

aMessageThe message containing the details of the client request that caused the leave.
aErrorThe leave code.

ServiceL ( const RMessage2 & )

voidServiceL(const RMessage2 &aMessage)[pure virtual]

Handles the servicing of a client request that has been passed to the server.

This function must be implemented in a derived class. The details of the request are contained within the message.

aMessageThe message containing the details of the client request.

SetServer ( const CServer2 * )

IMPORT_C voidSetServer(const CServer2 *aServer)

Designates the (master or slave) server that is to service this session.

This may be called from the NewSessionL() method of the CServer2-derived class or from the CreateL() method of the CSession2-derived class.

It must not be called after CreateL() has finished, as this is the point at which the session binding become irrevocable.

See also: CServer::DoConnect()