vpnengine/kmdserver/inc/kmdeventloggerif.h
changeset 0 33413c0669b9
equal deleted inserted replaced
-1:000000000000 0:33413c0669b9
       
     1 /*
       
     2 * Copyright (c) 2009 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:  KMD event logger interface
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_KMDEVENTLOGGERIF_H
       
    20 #define M_KMDEVENTLOGGERIF_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 #include "eventlogger.h"
       
    25 #include "eventmediatorapi.h"
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class TInetAddr;
       
    29 
       
    30 #define LOG_KMD_EVENT(a,b,c,d,e) EventLogger().LogEvent(a,b,c,d,e);
       
    31 #define LOG_KMD_EVENT2(a,b,c,d,e,f) EventLogger().LogEvent(a,b,c,d,e,f);
       
    32 
       
    33 /**
       
    34  *  KMD event logger interface.
       
    35  *
       
    36  *  Logger interface for logging KMD specific events to event log.
       
    37  *
       
    38  *  @lib internal (kmdserver.exe)
       
    39  */
       
    40 class MKmdEventLoggerIf
       
    41     {        
       
    42 public:    
       
    43 
       
    44     enum TKmdLogCategory
       
    45         {
       
    46         KLogInfo = 0,
       
    47         KLogWarning,
       
    48         KLogError,
       
    49         KLogDebug
       
    50         };
       
    51     
       
    52     /**
       
    53      * Writes event to event log.
       
    54      *
       
    55      * @param aCategory Log event category
       
    56      * @param aMsgId Msg Id
       
    57      * @param aStatus Status
       
    58      * @param aVpnIapId VPN IAP Id
       
    59      * @param aSgwIp SGW IP address
       
    60      * @param aLocalAddr Local IP address
       
    61      */
       
    62     virtual void LogEvent( TLogCategory aCategory,
       
    63                            TInt aMsgId,
       
    64                            TInt aStatus,
       
    65                            TUint32 aVpnIapId,
       
    66                            const TInetAddr* aSgwIp,
       
    67                            const TInetAddr* aLocalAddr = NULL ) = 0;
       
    68     
       
    69     /**
       
    70      * Writes event to event log.
       
    71      *
       
    72      * @param aCategory Log event category 
       
    73      * @param aMsgId Msg Id
       
    74      * @param aStatus Status
       
    75      * @param aVpnIapId VPN IAP Id
       
    76      * @param aSgwIp SGW IP address
       
    77      * @param aLocalAddr Local IP address
       
    78      */
       
    79     virtual void LogEvent( TKmdLogCategory aCategory,
       
    80                            TInt aMsgId,
       
    81                            TInt aStatus,
       
    82                            TUint32 aVpnIapId,
       
    83                            const TInetAddr* aSgwIp,
       
    84                            const TInetAddr* aLocalAddr = NULL ) = 0;
       
    85         
       
    86     };
       
    87 
       
    88 
       
    89 #endif // M_KMDEVENTLOGGERIF_H