1 /*

     2 * Copyright (c) 2006 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:   Application UI definition

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef M_ALFMETRICSINTERFACE_H

    21 #define M_ALFMETRICSINTERFACE_H

    22 

    23 #include <e32base.h>

    24 #include <e32cmn.h>

    25 

    26 class MAlfTraceInterface;

    27 

    28 class MAlfMetricsInterface

    29     {

    30 public:

    31     /**

    32      * New message from client has arrived. If the message shouldn't be processed futhther by session,

    33      * Message must be completed in the implementation of method

    34      *

    35      * @param aSessionId identifies the session which received the message.

    36      * @param aMessage refence to arrived message

    37      *

    38      */

    39     virtual void EnterClientMessageL(TInt aSessionId, const RMessage2& aMessage) = 0;

    40     

    41     /**

    42      * Handling of message has been completed in server, server is about to enter back to active status 

    43      *

    44      * @param aSessionId identifies the session which received the message.

    45      * @param aMessage refence to arrived message

    46      *

    47      */

    48     virtual void ExitClientMessage(TInt aSessionId, const RMessage2& aMessage) = 0;

    49     

    50     /**

    51      * Called when new session is created on the server.

    52      *

    53      * @param aSessionId Session id for new session

    54      *

    55      */

    56     virtual void SessionCreated(TInt aSessionId) = 0;

    57     

    58     /**

    59      * Called when session is closing down on the server.

    60      *

    61      * @param aSessionId Session id for the session

    62      *

    63      */

    64     virtual void SessionTerminated(TInt aSessionId) = 0;

    65     

    66     /**

    67      * Get trace object for session id.

    68      *

    69      * @since S60 v3.2

    70      * @param aSessionId Session id

    71      * @return Trace object, or NULL in case of unknown session id

    72      */

    73     virtual MAlfTraceInterface* GetTraceForSession(TInt aSessionId) const = 0;

    74 

    75     /**

    76      * Make new session be the default session

    77      *

    78      * @since S60 v3.2

    79      * @param aSessionId Session id

    80      *

    81      */

    82     virtual void PushDefaultSession(TInt aSessionId) = 0;

    83 

    84     /**

    85      * Restore to previous default session.

    86      *

    87      * @since S60 v3.2

    88      *

    89      */

    90     virtual void PopDefaultSession() = 0;

    91     

    92     /**

    93      * Get trace object for default session. If there's no default session defined, the

    94      * auxiliary trace will be returned.

    95      *

    96      * @since S60 v3.2

    97      * @return Trace object for default session

    98      */

    99     virtual MAlfTraceInterface& GetDefaultSessionTrace() const = 0;

   100 

   101     /**

   102      * Get the current default session id. If there's no default session defined,

   103      * the id will be 0.

   104      *

   105      * @since S60 v3.2

   106      * @return The default session id

   107      */

   108     virtual TInt GetDefaultSessionId() const = 0;

   109 

   110     /**

   111      * Get auxiliary trace object for tracing without exact session id.

   112      *

   113      * @since S60 v3.2

   114      * @param aSessionId Session id

   115      * @return Trace object, or NULL in case of unknown session id

   116      */

   117     virtual MAlfTraceInterface& GetAuxiliaryTrace() const = 0;

   118     };

   119 

   120 #endif // M_ALFMETRICSINTERFACE_H