#include <MSVAPI.H>
Link against:
msgs.lib
Link against:
msgs_autoshutdown.lib
class CMsvSession : public CActive;
Description
Represents a channel of communication between a client thread (Client-side MTM, User Interface MTM, or message client application) and the Message Server thread.
The class provides the means by which clients are notified when important Message Server events occur.
Note the following significant groups of functions:
Creation functions: a message client application must use CMsvSession::OpenSyncL(MMsvSessionObserver &) or OpenASyncL() to create a session object, before it can instantiate any MTM or CMsvEntry object. Only a single session should be created within a thread. As Client-side MTM, User Interface MTM, and CMsvEntry objects are created in the client thread, these use the client session, and do not create their own. Note that to close a
session, delete all objects relying on that session, and then the session object itself.
Cleanup functions: CMsvSession provides the ability to handle the cleanup of entries in the event of a leave occurring, in
a very similar manner to the standard cleanup stack. The difference is that, on a leave, any entries that are on the entry
cleanup stack are removed from the Message Server. The implementation uses the standard cleanup stack, so entry push and pop
functions should be used in the same order as all other types of push and pop. The functions can be used both by MTM implementations
and message client applications.
Derivation
CBase -
Base class for all classes to be instantiated on the heap.
CActive -
The core class of the active object abstraction.
CMsvSession - Represents a channel of communication between a client thread (Client-side MTM, ...
Members
Defined in CMsvSession:
AddObserverL(MMsvSessionObserver &)Registers a new session observer.ChangeAttributesL(const CMsvEntrySelection &,TUint,TUint)Provides a quick way to set or clear multiple fields in a selection of entries.ChangeDriveL(TInt,TRequestStatus &)Moves the Message Server index to the specified drive.CleanupEntry(TAny *)Cleans up an entry that has been added to the cleanup stack using CMsvSession::C...CleanupEntryPop(TInt)Pops one or more entries from the entry cleanup stack.CleanupEntryPushL(TMsvId)Pushes the specified entry ID to the entry cleanup stack.CloseMessageServer()Closes down the Message Server.CopyStoreL(const TDriveUnit &,TRequestStatus &)Copies the Message Store to the specified drive.CurrentDriveL()DeInstallMtmGroup(const TDesC &)Removes an installed MTM.DecPcSyncCountL(const CMsvEntrySelection &)Decreases the PC synchronisation index field for a selection of entries.DeleteStoreL(const TDriveUnit &,TRequestStatus &)Deletes the Message Store to the specified drive.DoCancel()Implements cancellation of an outstanding request.DriveContainsStoreL(TDriveUnit)FileSession()Allows a Server-side MTM to access the file session handle created by the Messag...GetAndClearIndexCorruptFlagL()Checks a flag in the message server that is set when the server deletes a corrup...GetChildIdsL(TMsvId,const CMsvEntryFilter &,CMsvEntrySelection &)Gets filtered list of children of a specified message entry.GetEntry(TMsvId,TMsvId &,TMsvEntry &)Gets the index entry for the specified entry ID.GetEntryL(TMsvId)Accesses the entry with the specified ID.GetMtmRequiredCapabilitiesL(TUid,TCapabilitySet &)constGets the additional security capabilities required by a given MTM, over and abov...IncPcSyncCountL(const CMsvEntrySelection &)Increases the PC synchronisation index field for a selection of entries.InstallMtmGroup(const TDesC &)MTM functions. MessageStoreDrivePresentL()Checks to see if the currently selected drive contains the correct mail store.OpenAsObserverL(MMsvSessionObserver &)Creates a session that is used only as an observer.OpenAsObserverL(MMsvSessionObserver &,RFs &)Creates a session that is used only as an observer.OpenAsObserverL(MMsvSessionObserver &,RFs &,TInt)Creates a session that is used only as an observer.OpenAsObserverL(MMsvSessionObserver &,TInt)Creates a session that is used only as an observer.OpenAsyncL(MMsvSessionObserver &)Creates a session asynchronously.OpenAsyncL(MMsvSessionObserver &,RFs &)Creates a session asynchronously.OpenAsyncL(MMsvSessionObserver &,RFs &,TInt)Creates a session asynchronously.OpenAsyncL(MMsvSessionObserver &,TInt)Creates a session asynchronously.OpenSyncL(MMsvSessionObserver &)Creates a session synchronously.OpenSyncL(MMsvSessionObserver &,RFs &)Creates a session synchronously.OpenSyncL(MMsvSessionObserver &,RFs &,TInt)Creates a session synchronously.OpenSyncL(MMsvSessionObserver &,TInt)Creates a session synchronously.OperationId()OutstandingOperationsL()Gets the number of outstanding operations.RemoveEntry(TMsvId)Deletes the specified entry from the Message Server.RemoveObserver(MMsvSessionObserver &)Deregisters a previously registered observer.RunError(TInt)RunL()Handles an active object's request completion event.ServiceAccessPointId(TMsvId,TUint32 &)Get the ID of the access point currently in use by the server side MTM for the g...ServiceActive(TMsvId)Tests whether a Server-side MTM for a particular service is loaded by the Messag...ServiceProgress(TMsvId,TDes8 &)Gets the current progress information from the Server-side MTM for the specified...Session()SetReceiveEntryEvents(TBool)Sets whether the session's observer should be notified of events related to chan...StopService(TMsvId)Stops any operations that a Server-side MTM for the specified service is running...TransferCommandL(const CMsvEntrySelection &,TInt,const TDesC8 &,TDes8 &)Passes MTM-specific operations synchronously to the associated Server-side MTM b...TransferCommandL(const CMsvEntrySelection &,TInt,const TDesC8 &,TRequestStatus &)Passes MTM-specific operations asynchronously to the associated Server-side MTM ...
Inherited from CActive:
CActive(TInt)Constructs the active object with the specified priority.Cancel()Cancels the wait for completion of an outstanding request.Deque()Removes the active object from the active scheduler's list of active objects.EPriorityHighA priority higher than EPriorityUserInput.EPriorityIdleA low priority, useful for active objects representing background processing.EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.EPriorityStandardMost active objects will have this priority.EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...Extension_(TUint,TAny *&,TAny *)Extension function IsActive()constDetermines whether the active object has a request outstanding.IsAdded()constDetermines whether the active object has been added to the active scheduler's li...Priority()constGets the priority of the active object.SetActive()Indicates that the active object has issued a request and that it is now outstan...SetPriority(TInt)Sets the priority of the active object.TPriorityDefines standard priorities for active objects. iStatusThe request status associated with an asynchronous request.
Inherited from CBase:
Related Topics
»
Symbian OS v9.4 »
Examples »
Messaging example code »
Imap4Example: An Email manager using IMAP4 and SMTP
»
Symbian OS v9.4 »
Examples »
Messaging example code »
Pop3Example: An Email manager using POP3 and SMTP
Member functions
OpenSyncL(MMsvSessionObserver &)
IMPORT_C static CMsvSession* OpenSyncL(MMsvSessionObserver &aObserver);
Description
Creates a session synchronously.
The session can be used once the function returns.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsyncL(MMsvSessionObserver &)
IMPORT_C static CMsvSession* OpenAsyncL(MMsvSessionObserver &aObserver);
Description
Creates a session asynchronously.
The session cannot be used until the passed MMsvSessionObserver observer has been informed that the message server is ready with TMsvSessionEvent::EMsvServerReady. If any functions are
called before this, they will fail with KErrNotReady.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsObserverL(MMsvSessionObserver &)
IMPORT_C static CMsvSession* OpenAsObserverL(MMsvSessionObserver &aObserver);
Description
Creates a session that is used only as an observer.
The session created with this function should only be used to observe events, and not actively use the server. It used for
applications such as system monitoring utilities.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenSyncL(MMsvSessionObserver &,RFs &)
IMPORT_C static CMsvSession* OpenSyncL(MMsvSessionObserver &aObserver, RFs &aFs);
Description
Creates a session synchronously.
The session can be used once the function returns.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsyncL(MMsvSessionObserver &,RFs &)
IMPORT_C static CMsvSession* OpenAsyncL(MMsvSessionObserver &aObserver, RFs &aFs);
Description
Creates a session asynchronously.
The session cannot be used until the passed MMsvSessionObserver observer has been informed that the message server is ready with TMsvSessionEvent::EMsvServerReady. If any functions are
called before this, they will fail with KErrNotReady.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsObserverL(MMsvSessionObserver &,RFs &)
IMPORT_C static CMsvSession* OpenAsObserverL(MMsvSessionObserver &aObserver, RFs &aFs);
Description
Creates a session that is used only as an observer.
The session created with this function should only be used to observe events, and not actively use the server. It used for
applications such as system monitoring utilities.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenSyncL(MMsvSessionObserver &,TInt)
IMPORT_C static CMsvSession* OpenSyncL(MMsvSessionObserver &aObserver, TInt aPriority);
Description
Creates a session synchronously.
The session can be used once the function returns. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsyncL(MMsvSessionObserver &,TInt)
IMPORT_C static CMsvSession* OpenAsyncL(MMsvSessionObserver &aObserver, TInt aPriority);
Description
Creates a session asynchronously.
The session cannot be used until the passed MMsvSessionObserver observer has been informed that the message server is ready with TMsvSessionEvent::EMsvServerReady. If any functions are
called before this, they will fail with KErrNotReady. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsObserverL(MMsvSessionObserver &,TInt)
IMPORT_C static CMsvSession* OpenAsObserverL(MMsvSessionObserver &aObserver, TInt aPriority);
Description
Creates a session that is used only as an observer.
The session created with this function should only be used to observe events, and not actively use the server. It used for
applications such as system monitoring utilities. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenSyncL(MMsvSessionObserver &,RFs &,TInt)
IMPORT_C static CMsvSession* OpenSyncL(MMsvSessionObserver &aObserver, RFs &aFs, TInt aPriority);
Description
Creates a session synchronously.
The session can be used once the function returns. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsyncL(MMsvSessionObserver &,RFs &,TInt)
IMPORT_C static CMsvSession* OpenAsyncL(MMsvSessionObserver &aObserver, RFs &aFs, TInt aPriority);
Description
Creates a session asynchronously.
The session cannot be used until the passed MMsvSessionObserver observer has been informed that the message server is ready with TMsvSessionEvent::EMsvServerReady. If any functions are
called before this, they will fail with KErrNotReady. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
OpenAsObserverL(MMsvSessionObserver &,RFs &,TInt)
IMPORT_C static CMsvSession* OpenAsObserverL(MMsvSessionObserver &aObserver, RFs &aFs, TInt aPriority);
Description
Creates a session that is used only as an observer.
The session created with this function should only be used to observe events, and not actively use the server. It used for
applications such as system monitoring utilities. Clients to specify a priority that is tuned to their scheduler.
Parameters
MMsvSessionObserver &aObserver |
A reference to a session observer, through which the program can be notified of important events regarding entries, MTMs,
and the Message Server.
|
RFs &aFs |
A connected file server session
|
TInt aPriority |
Active object priority
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory to create object.
|
|
AddObserverL(MMsvSessionObserver &)
IMPORT_C void AddObserverL(MMsvSessionObserver &aObserver);
Description
Registers a new session observer.
CMsvSession objects can call back observer objects that implement the MMsvSessionObserver::HandleSessionEvent() when certain
events occur. Any number of observers can be registered.
For details of when observers are called, see TMsvSessionEvent::TMsvEntryEvent.
Parameters
Leave codes
KErrNoMemory |
Not enough memory to register the observer
|
|
RemoveObserver(MMsvSessionObserver &)
IMPORT_C void RemoveObserver(MMsvSessionObserver &aObserver);
Description
Deregisters a previously registered observer.
Parameters
SetReceiveEntryEvents(TBool)
IMPORT_C TInt SetReceiveEntryEvents(TBool aReceive);
Description
Sets whether the session's observer should be notified of events related to changes in message server entries.
If the flag is set to true, the session observer will be notified of all events types. If it is set to false, the observer
will not be notified of events of types EMsvEntriesCreated, EMsvEntriesChanged, EMsvEntriesDeleted, or EMsvEntriesMoved. (Event
types are enumerated in MMsvSessionObserver::TMsvSessionEvent.)
If a session has additional observers, as set through AddObserver(), then the value of this flag is ignored, and the observers
receive notification of all events.
Parameters
Return value
TInt
|
Symbian OS error code
|
|
See also:
IMPORT_C CMsvEntry* GetEntryL(TMsvId aEntId);
Description
Accesses the entry with the specified ID.
If a client is unaware of the entries that exist, it can set aId to KMsvRootIndexEntryId to obtain the root entry, from where
all other entries can be obtained.
The CMsvEntry object must be deleted by the client when it is no longer required.
Parameters
TMsvId aEntId |
The ID of the entry to access
|
|
Return value
Leave codes
KErrNotFound |
The requested entry does not exist
|
|
GetEntry(TMsvId,TMsvId &,TMsvEntry &)
IMPORT_C TInt GetEntry(TMsvId aId, TMsvId &aService, TMsvEntry &aEntry);
Description
Gets the index entry for the specified entry ID.
Parameters
TMsvId aId |
The ID of the entry to access
|
TMsvId &aService |
On return, the ID of the service that owns the entry
|
TMsvEntry &aEntry |
On return, the index entry
|
|
Return value
TInt
|
KErrNone if successful, otherwise one of the system-wide error codes
|
|
TransferCommandL(const CMsvEntrySelection &,TInt,const TDesC8 &,TRequestStatus &)
IMPORT_C CMsvOperation* TransferCommandL(const CMsvEntrySelection &aSelection, TInt aCommandId, const TDesC8 &aParameter,
TRequestStatus &aStatus);
Description
Passes MTM-specific operations asynchronously to the associated Server-side MTM by means of the Message Server.
It is typically used in the implementation of CBaseMtm::InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)/InvokeAsyncFunctionL() and CBaseMtmUi::InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)/InvokeAsyncFunctionL(). It is not used by message client applications. How the passed aSelection and aParameter parameters
are used is specific to the operation.
Calling this function results in the Message Server calling CBaseServerMtm::StartCommandL(CMsvEntrySelection &,TInt,const TDesC8 &,TRequestStatus &) on the relevant Server-side MTM. If the Server-side MTM is not already loaded, then the Message Server loads it.
The returned CMsvOperation object completes when the operation is complete.
Parameters
const CMsvEntrySelection &aSelection |
A selection of entries that may be relevant to the operation
|
TInt aCommandId |
The command ID. The interpretation of the command is MTM-specific.
|
const TDesC8 &aParameter |
A descriptor containing operation-specific parameters
|
TRequestStatus &aStatus |
The request status to be completed when the operation has finished
|
|
Return value
Leave codes
KErrNoMemory |
Not enough memory
|
|
TransferCommandL(const CMsvEntrySelection &,TInt,const TDesC8 &,TDes8 &)
IMPORT_C void TransferCommandL(const CMsvEntrySelection &aSelection, TInt aCommandId, const TDesC8 &aParameter, TDes8 &aProgress);
Description
Passes MTM-specific operations synchronously to the associated Server-side MTM by means of the Message Server.
It is typically used in the implementation of CBaseMtm::InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &) and CBaseMtmUi::InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &). It is not used by message client applications. How the passed aSelection and aParameter parameters are used is specific
to the operation.
Calling this function results in the Message Server calling CBaseServerMtm::StartCommandL(CMsvEntrySelection &,TInt,const TDesC8 &,TRequestStatus &) on the relevant Server-side MTM. If the Server-side MTM is not already loaded, then the Message Server loads it.
Parameters
const CMsvEntrySelection &aSelection |
A selection of entries that may be relevant to the operation
|
TInt aCommandId |
The command ID. The interpretation of the command is MTM-specific.
|
const TDesC8 &aParameter |
A descriptor containing operation-specific parameters
|
TDes8 &aProgress |
Progress information returned from the Message Server
|
|
Leave codes
KErrNoMemory |
Not enough memory
|
|
IncPcSyncCountL(const CMsvEntrySelection &)
IMPORT_C void IncPcSyncCountL(const CMsvEntrySelection &aSelection);
Description
Increases the PC synchronisation index field for a selection of entries.
Parameters
const CMsvEntrySelection &aSelection |
Entries for which to increase the PC synchronisation index field
|
|
DecPcSyncCountL(const CMsvEntrySelection &)
IMPORT_C void DecPcSyncCountL(const CMsvEntrySelection &aSelection);
Description
Decreases the PC synchronisation index field for a selection of entries.
If an entry has its Deleted flag set, and this call causes its PC synchronisation field to become zero, then the entry is
permanently deleted.
Parameters
const CMsvEntrySelection &aSelection |
Entries for which to decrease the PC synchronisation index field
|
|
GetChildIdsL(TMsvId,const CMsvEntryFilter &,CMsvEntrySelection &)
IMPORT_C void GetChildIdsL(TMsvId aId, const CMsvEntryFilter &aFilter, CMsvEntrySelection &aSelection);
Description
Gets filtered list of children of a specified message entry.
Parameters
TMsvId aId |
Message entry of which to get children
|
const CMsvEntryFilter &aFilter |
Filter by which various message entries can be excluded
|
CMsvEntrySelection &aSelection |
On return, a list of message entry IDs
|
|
ChangeAttributesL(const CMsvEntrySelection &,TUint,TUint)
IMPORT_C void ChangeAttributesL(const CMsvEntrySelection &aSelection, TUint aSetAttributes, TUint aClearAttributes);
Description
Provides a quick way to set or clear multiple fields in a selection of entries.
Fields to change are specified using a bitmask of TMsvAttribute values. Possible fields that can be changed using this function
are:
1. PC synchronisation
2. Visibility flag
3. Read flag
4. In-preparation flag
5. Connected flag
6. New flag
Parameters
const CMsvEntrySelection &aSelection |
The entries to change
|
TUint aSetAttributes |
A bitmask of the fields to set
|
TUint aClearAttributes |
A bitmask of the fields to clear
|
|
See also:
TMsvAttributeSupplies values for bitmasks that allows the rapid setting or clearing of a numb...
ChangeDriveL(TInt,TRequestStatus &)
IMPORT_C CMsvOperation* ChangeDriveL(TInt aDrive, TRequestStatus &aStatus);
Description
Moves the Message Server index to the specified drive.
Progress information is provided by a TMsvIndexLoadProgress object.
If an error occurs, the index is unchanged.
Parameters
TInt aDrive |
The drive to which to move the Message Server index, specified by a TDriveNumber value
|
TRequestStatus &aStatus |
Asynchronous completion status
|
|
Return value
CMsvOperation * |
Asynchronous operation used to control the move. The operation's MTM value is set to KUidMsvServerMtm, which can be used to
distinguish it from a local operation.
|
|
Leave codes
KErrServerBusy |
Cannot change drive because there are outstanding Message Server operations.
|
|
See also:
IMPORT_C TInt OutstandingOperationsL();
Description
Gets the number of outstanding operations.
Return value
TInt
|
The number of outstanding operations
|
|
CopyStoreL(const TDriveUnit &,TRequestStatus &)
IMPORT_C CMsvOperation* CopyStoreL(const TDriveUnit &aDrive, TRequestStatus &aStatus);
Description
Copies the Message Store to the specified drive.
Progress information is provided by a TMsvCopyProgress object.
If an error occurs, the Message Store is unchanged.
Parameters
const TDriveUnit &aDrive |
The drive to which to copy the Message Store, specified by a TDriveUnit value
|
TRequestStatus &aStatus |
Asynchronous completion status
|
|
Return value
CMsvOperation * |
Asynchronous operation used to control the move. The operation's MTM value is set to KUidMsvServerMtm, which can be used to
distinguish it from a local operation.
|
|
Leave codes
KErrServerBusy |
Cannot copy store because there are outstanding Message Server operations.
|
|
DeleteStoreL(const TDriveUnit &,TRequestStatus &)
IMPORT_C CMsvOperation* DeleteStoreL(const TDriveUnit &aDrive, TRequestStatus &aStatus);
Description
Deletes the Message Store to the specified drive.
Progress information is provided by a TMsvDeleteProgress object.
If an error occurs, the Message Store is unchanged.
Parameters
const TDriveUnit &aDrive |
The drive to which to copy the Message Store, specified by a TDriveUnit value
|
TRequestStatus &aStatus |
Asynchronous completion status
|
|
Return value
CMsvOperation * |
Asynchronous operation used to control the move. The operation's MTM value is set to KUidMsvServerMtm, which can be used to
distinguish it from a local operation.
|
|
Leave codes
KErrServerBusy |
Cannot copy store because there are outstanding Message Server operations.
|
|
IMPORT_C static void CleanupEntry(TAny *aPtr);
Description
Cleans up an entry that has been added to the cleanup stack using CMsvSession::CleanupEntryPushL(TMsvId).
This function defines the clean up function that is called when an entry on the stack needs cleaning up.
Parameters
TAny *aPtr |
Pointer to the current message server session
|
|
CleanupEntryPushL(TMsvId)
IMPORT_C void CleanupEntryPushL(TMsvId aId);
Description
Pushes the specified entry ID to the entry cleanup stack.
Parameters
TMsvId aId |
The ID of the entry to push onto the entry cleanup stack
|
|
Leave codes
ErrNoMemory |
The entry will have been pushed onto the entry cleanup stack before the leave occurs
|
|
IMPORT_C void CleanupEntryPop(TInt aCount=1);
Description
Pops one or more entries from the entry cleanup stack.
Parameters
TInt aCount |
The number of entries to pop off the entry cleanup stack
|
|
IMPORT_C void RemoveEntry(TMsvId aId);
Description
Deletes the specified entry from the Message Server.
The call is guaranteed not to fail. If the entry cannot be deleted immediately, it will be deleted later. This call should
only be used in preference to the normal deleting mechanism when no error reporting is required, typically in a destructor.
Parameters
TMsvId aId |
The ID of the entry to remove
|
|
InstallMtmGroup(const TDesC &)
IMPORT_C TInt InstallMtmGroup(const TDesC &aFullName);
Description
MTM functions.
Installs a new group of MTMs.
It is used by specialised MTM-installation programs.
Parameters
const TDesC16 &aFullName |
The full path name of the MTM group file
|
|
Return value
TInt
|
KErrNone - success; KErrAlreadyExists - MTM already installed
|
|
DeInstallMtmGroup(const TDesC &)
IMPORT_C TInt DeInstallMtmGroup(const TDesC &aFullName);
Description
Removes an installed MTM.
It is used by specialised MTM-deinstallation programs.
Parameters
const TDesC16 &aFullName |
The full path name of the MTM group file
|
|
Return value
TInt
|
KErrNone - success; KErrInUse - The MTM is currently being used
|
|
IMPORT_C TInt StopService(TMsvId aServiceId);
Description
Stops any operations that a Server-side MTM for the specified service is running, and then unloads the Server-side MTM.
The current operation and any queued operations are cancelled.
Parameters
TMsvId aServiceId |
The ID of the service to stop
|
|
Return value
IMPORT_C TBool ServiceActive(TMsvId aServiceId);
Description
Tests whether a Server-side MTM for a particular service is loaded by the Message Server.
The Server-side MTM does not have to be executing a command - it may be waiting for another command.
Parameters
TMsvId aServiceId |
The ID of the relevant service
|
|
Return value
TBool
|
ETrue if the Server-side MTM for the service is loaded, otherwise EFalse
|
|
ServiceProgress(TMsvId,TDes8 &)
IMPORT_C TInt ServiceProgress(TMsvId aServiceId, TDes8 &aProgress);
Description
Gets the current progress information from the Server-side MTM for the specified service.
It is typically used by User Interface MTMs. The format of the progress information returned in the aProgress buffer is MTM-specific.
Calling this function results in the Message Server calling CBaseServerMtm::Progress() on the relevant Server-side MTM.
Note that the progress information is independent of which message client application started the current operation.
Parameters
TMsvId aServiceId |
The ID of the service from which to get the progress information
|
TDes8 &aProgress |
On return, a descriptor holding progress information. It is the caller's responsibility to ensure the descriptor is large
enough for this information.
|
|
Return value
TInt
|
KErrNone - success; KErrNotFound - The service is not active (the relevant Server-side MTM is not loaded by the Message Server);
KErrOverflow - The descriptor was too small for the progress information
|
|
IMPORT_C void CloseMessageServer();
Description
Closes down the Message Server.
Normal clients should not use this function, as it will affect other message clients.
The function results in the session sending a shutdown session notification (EMsvCloseSession) to all current sessions. The Message Server closes when all sessions have been closed.
IMPORT_C RFs& FileSession();
Description
Allows a Server-side MTM to access the file session handle created by the Message Server.
This is preferable, as more efficient, to creating another handle.
Return value
RFs & |
File session handle
|
|
GetMtmRequiredCapabilitiesL(TUid,TCapabilitySet &)const
IMPORT_C void GetMtmRequiredCapabilitiesL(TUid aMtmTypeUid, TCapabilitySet &aCapSet) const;
Description
Gets the additional security capabilities required by a given MTM, over and above those required by the message server itself.
Parameters
TUid aMtmTypeUid |
The type UID of the MTM being queried
|
TCapabilitySet &aCapSet |
A reference to a TCapabilitySet in which the security capabilities will be returned. Any existing capabilities will be removed.
|
|
GetAndClearIndexCorruptFlagL()
IMPORT_C TBool GetAndClearIndexCorruptFlagL();
Description
Checks a flag in the message server that is set when the server deletes a corrupt index file. Then clears the flag.
It is intended to allow the message centre UI to check whether a corrupt index has been deleted on startup. If it has the
UI may inform the user about the loss of their messages.
Return value
TBool
|
ETrue if a corrupt index flag was present indicating that a corrupt index file has been deleted since the last time this function
was called.
|
|
IMPORT_C TDriveUnit CurrentDriveL();
Description
Return value
DriveContainsStoreL(TDriveUnit)
IMPORT_C TBool DriveContainsStoreL(TDriveUnit aDrive);
Description
Parameters
Return value
MessageStoreDrivePresentL()
IMPORT_C TBool MessageStoreDrivePresentL();
Description
Checks to see if the currently selected drive contains the correct mail store.
Return value
TBool
|
ETrue if the same drive is mounted. otherwise returns EFalse
|
|
ServiceAccessPointId(TMsvId,TUint32 &)
IMPORT_C TInt ServiceAccessPointId(TMsvId aServiceId, TUint32 &aAccessPointId);
Description
Get the ID of the access point currently in use by the server side MTM for the given service ID
Parameters
TMsvId aServiceId |
|
TUint32 &aAccessPointId |
If return code is KErrNone, this will store the access point ID
|
|
Return value
TInt
|
KErrNone if successful, KErrNotSupported if the server side MTM does not support this operation, KErrNotFound if the server
side MTM is not connected at the time of the request, or one of the other system wide error codes.
|
|
protected: IMPORT_C TInt OperationId();
Description
Return value
protected: IMPORT_C RMsvServerSession& Session();
Description
Return value
protected: virtual void RunL();
Description
Handles an active object's request completion event.
A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.
The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest()
function completes.
Before calling this active object's CMsvSession::RunL() function, the active scheduler has:
1. decided that this is the highest priority active object with a completed request
2. marked this active object's request as complete (i.e. the request is no longer outstanding)
CMsvSession::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CMsvSession::RunError(TInt) to handle the leave.
Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active
object's CMsvSession::RunL() or CMsvSession::RunError(TInt) functions.
See also:
protected: virtual void DoCancel();
Description
Implements cancellation of an outstanding request.
This function is called as part of the active object's CActive::Cancel().
It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous
service provider's cancel is expected to act immediately.
CMsvSession::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().
See also:
protected: virtual TInt RunError(TInt aError);
Description
Parameters
Return value
![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)