keepalive/flextimer/test/testflextimer/flextimerservermonitor/inc/flextimerservermonitorserver.h
author hgs
Mon, 24 May 2010 20:51:35 +0300
changeset 32 5c4486441ae6
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description:
hgs
parents:
diff changeset
    15
 *      Server implementation for FlexTimerServerMonitor.
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
/*
hgs
parents:
diff changeset
    18
 * %version: 1 %
hgs
parents:
diff changeset
    19
 */
hgs
parents:
diff changeset
    20
// Protection against nested includes
hgs
parents:
diff changeset
    21
#ifndef FLEXTIMERSERVERMONITORSERVER_H
hgs
parents:
diff changeset
    22
#define FLEXTIMERSERVERMONITORSERVER_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// System includes
hgs
parents:
diff changeset
    25
#include <e32base.h>
hgs
parents:
diff changeset
    26
#include <rflextimer.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// Class declaration
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * A server for detecting, has FlexTimerServer crashed during the
hgs
parents:
diff changeset
    31
 * monitoring period.
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
class CFlexTimerServerMonitorServer : public CServer2
hgs
parents:
diff changeset
    34
    {
hgs
parents:
diff changeset
    35
    
hgs
parents:
diff changeset
    36
public:
hgs
parents:
diff changeset
    37
    /**
hgs
parents:
diff changeset
    38
     * Two phased constructor 
hgs
parents:
diff changeset
    39
     * 
hgs
parents:
diff changeset
    40
     * @param aPriority Active object priority for the server 
hgs
parents:
diff changeset
    41
     * @return Pointer to created server object
hgs
parents:
diff changeset
    42
     */
hgs
parents:
diff changeset
    43
    IMPORT_C static CFlexTimerServerMonitorServer* NewL( 
hgs
parents:
diff changeset
    44
        CActive::TPriority aPriority );
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
     * Destructor 
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    virtual ~CFlexTimerServerMonitorServer();
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
public:
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
    /**
hgs
parents:
diff changeset
    54
     * From CServer2
hgs
parents:
diff changeset
    55
     * Function for creating a new session to this server. 
hgs
parents:
diff changeset
    56
     *
hgs
parents:
diff changeset
    57
     * @param aVersion Version identifier from client
hgs
parents:
diff changeset
    58
     * @param aMessage Reference to creation message sent by client
hgs
parents:
diff changeset
    59
     * @return Pointer to created session object
hgs
parents:
diff changeset
    60
     */
hgs
parents:
diff changeset
    61
    CSession2* NewSessionL( const TVersion& aVersion,
hgs
parents:
diff changeset
    62
                            const RMessage2& aMessage ) const;
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * Function for creating server thread resources. Creates the server
hgs
parents:
diff changeset
    66
     * object and active scheduler. Loops in the active scheduler to serve
hgs
parents:
diff changeset
    67
     * client requests until explicitly shutdown. Function leaves if the
hgs
parents:
diff changeset
    68
     * creation of needed resources fails.
hgs
parents:
diff changeset
    69
     */
hgs
parents:
diff changeset
    70
    static void StartServerL();
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    /**
hgs
parents:
diff changeset
    73
     * Start monitoring FlexTimer server crashing.
hgs
parents:
diff changeset
    74
     * 
hgs
parents:
diff changeset
    75
     * @return KErrNone when succeeded, KErrAlreadyExists if monitoring was
hgs
parents:
diff changeset
    76
     * already started, or any other system level error code.
hgs
parents:
diff changeset
    77
     */
hgs
parents:
diff changeset
    78
    TInt StartMonitoring();
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
    /**
hgs
parents:
diff changeset
    81
     * Stop monitoring FlexTimer server crashing.
hgs
parents:
diff changeset
    82
     * 
hgs
parents:
diff changeset
    83
     * @return KErrNone when succeeded, KErrNotFound if monitoring is not
hgs
parents:
diff changeset
    84
     * started.
hgs
parents:
diff changeset
    85
     */
hgs
parents:
diff changeset
    86
    TInt StopMonitoring();
hgs
parents:
diff changeset
    87
    
hgs
parents:
diff changeset
    88
    /**
hgs
parents:
diff changeset
    89
     * Get status of monitoring the server. I.e. has the server crashed or 
hgs
parents:
diff changeset
    90
     * not.
hgs
parents:
diff changeset
    91
     *
hgs
parents:
diff changeset
    92
     * @param aHasServerCrashed Return ETrue if server has crashed while
hgs
parents:
diff changeset
    93
     * monitoring, otherwise EFalse.
hgs
parents:
diff changeset
    94
     * @return KErrNone when succeeded, KErrNotFound if monitoring is not
hgs
parents:
diff changeset
    95
     * started.
hgs
parents:
diff changeset
    96
     */
hgs
parents:
diff changeset
    97
    TInt GetStatus( TBool& aHasServerCrashed );
hgs
parents:
diff changeset
    98
    
hgs
parents:
diff changeset
    99
private:
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
    /**
hgs
parents:
diff changeset
   102
     * Constructor
hgs
parents:
diff changeset
   103
     * 
hgs
parents:
diff changeset
   104
     * @param aPriority Active object priority 
hgs
parents:
diff changeset
   105
     */
hgs
parents:
diff changeset
   106
    CFlexTimerServerMonitorServer( CActive::TPriority aPriority );
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
private: // Data
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
    /**
hgs
parents:
diff changeset
   111
     * Handle to FlexTimer server.
hgs
parents:
diff changeset
   112
     * This parameter needs to be in server due it is manipulated by
hgs
parents:
diff changeset
   113
     * multible sessions.
hgs
parents:
diff changeset
   114
     */
hgs
parents:
diff changeset
   115
    RFlexTimer iFlexTimer;
hgs
parents:
diff changeset
   116
    
hgs
parents:
diff changeset
   117
    /**
hgs
parents:
diff changeset
   118
     * State of monitoring. ETrue if monitoring has started, EFalse if not.
hgs
parents:
diff changeset
   119
     * This state is introduced for preventing starting/stopping the
hgs
parents:
diff changeset
   120
     * monitoring more than once in a row.
hgs
parents:
diff changeset
   121
     */
hgs
parents:
diff changeset
   122
    TBool iIsMonitoringOn;
hgs
parents:
diff changeset
   123
    };
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
#endif /* FLEXTIMERSERVERMONITORSERVER_H */