keepalive/flextimer/test/testflextimer/flextimerservermonitor/inc/rflextimerservermonitor.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
 *      Client implementation for FlexTimerServerMonitor
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
/*
hgs
parents:
diff changeset
    19
 * %version: 1 %
hgs
parents:
diff changeset
    20
 */
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#ifndef RFLEXTIMERSERVERMONITOR_H
hgs
parents:
diff changeset
    23
#define RFLEXTIMERSERVERMONITOR_H
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// INCLUDE FILES
hgs
parents:
diff changeset
    26
#include <e32std.h> 
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// CLASS DECLARATION
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * Client implementation for FlexTimerServerMonitor.
hgs
parents:
diff changeset
    31
 * Forwards all requests as synchronous messages to the client.
hgs
parents:
diff changeset
    32
 * 
hgs
parents:
diff changeset
    33
 * Creates the server if it is not up'n'running when connecting to the server
hgs
parents:
diff changeset
    34
 * at the first time.
hgs
parents:
diff changeset
    35
 * 
hgs
parents:
diff changeset
    36
 * StartMonitoring() has to be called before StopMonitoring() and GetStatus()
hgs
parents:
diff changeset
    37
 * works. Note! The starting can be done by different handle. I.e.
hgs
parents:
diff changeset
    38
 * 
hgs
parents:
diff changeset
    39
 * @code
hgs
parents:
diff changeset
    40
 * 
hgs
parents:
diff changeset
    41
 *      RFlexTimerServerMonitor mon1;
hgs
parents:
diff changeset
    42
 *      mon1.Connect();
hgs
parents:
diff changeset
    43
 *      mon1.StartMonitoring();
hgs
parents:
diff changeset
    44
 *      mon1.Close();
hgs
parents:
diff changeset
    45
 *      
hgs
parents:
diff changeset
    46
 *      .
hgs
parents:
diff changeset
    47
 *      .
hgs
parents:
diff changeset
    48
 *      . 
hgs
parents:
diff changeset
    49
 *      
hgs
parents:
diff changeset
    50
 *      RFlexTimerServerMonitor mon2;
hgs
parents:
diff changeset
    51
 *      mon2.Connect();
hgs
parents:
diff changeset
    52
 *      TBool hasCrashed;
hgs
parents:
diff changeset
    53
 *      mon2.GetStatus( hasCrashed );
hgs
parents:
diff changeset
    54
 *      // Do your stuff
hgs
parents:
diff changeset
    55
 *      ...
hgs
parents:
diff changeset
    56
 *      mon2.StopMonitoring();
hgs
parents:
diff changeset
    57
 *      mon2.Close();
hgs
parents:
diff changeset
    58
 *      
hgs
parents:
diff changeset
    59
 * @endcode
hgs
parents:
diff changeset
    60
 */
hgs
parents:
diff changeset
    61
class RFlexTimerServerMonitor : public RSessionBase
hgs
parents:
diff changeset
    62
    {
hgs
parents:
diff changeset
    63
public:
hgs
parents:
diff changeset
    64
    // Constructors and destructors
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    /**
hgs
parents:
diff changeset
    67
     * Constructor
hgs
parents:
diff changeset
    68
     */
hgs
parents:
diff changeset
    69
    IMPORT_C RFlexTimerServerMonitor();
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
    /**
hgs
parents:
diff changeset
    72
     * Destructor
hgs
parents:
diff changeset
    73
     */
hgs
parents:
diff changeset
    74
    IMPORT_C ~RFlexTimerServerMonitor();
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * Connect to the server.
hgs
parents:
diff changeset
    78
     * 
hgs
parents:
diff changeset
    79
     * @return KErrNone on success. Otherwise returns one of the system-wide
hgs
parents:
diff changeset
    80
     * error codes.
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    IMPORT_C TInt Connect();
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * Start detecting the crashes.
hgs
parents:
diff changeset
    86
     * 
hgs
parents:
diff changeset
    87
     * @return KErrNone if succeeded, KErrAlreadyExists if monitoring is
hgs
parents:
diff changeset
    88
     * already activated, or any other system-wide error code.
hgs
parents:
diff changeset
    89
     */
hgs
parents:
diff changeset
    90
    IMPORT_C TInt StartMonitoring();
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
     * Stop detecting the crashes.
hgs
parents:
diff changeset
    94
     * 
hgs
parents:
diff changeset
    95
     * @return KErrNone if succeeded, KErrNotFound if monitoring is not
hgs
parents:
diff changeset
    96
     * activated, or any other system-wide error code.
hgs
parents:
diff changeset
    97
     */
hgs
parents:
diff changeset
    98
    IMPORT_C TInt StopMonitoring();
hgs
parents:
diff changeset
    99
    
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * Get the current status of monitoring.
hgs
parents:
diff changeset
   102
     * 
hgs
parents:
diff changeset
   103
     * 
hgs
parents:
diff changeset
   104
     * @param aHasServerCrashed ETrue if server has crashed, EFalse otherwise
hgs
parents:
diff changeset
   105
     * @return KErrNone if succeeded, KErrNotFound if monitoring is not
hgs
parents:
diff changeset
   106
     * activated, or any other system-wide error code.
hgs
parents:
diff changeset
   107
     */
hgs
parents:
diff changeset
   108
    IMPORT_C TInt GetStatus( TBool& aHasServerCrashed );
hgs
parents:
diff changeset
   109
    
hgs
parents:
diff changeset
   110
private:
hgs
parents:
diff changeset
   111
    
hgs
parents:
diff changeset
   112
    /**
hgs
parents:
diff changeset
   113
     * Gets the version number.
hgs
parents:
diff changeset
   114
     * @return The version.
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    TVersion Version() const;
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    /**
hgs
parents:
diff changeset
   119
     * Connects to the server. If server does not exist, it is created.
hgs
parents:
diff changeset
   120
     * @return KErrNone on success. Otherwise returns one of the system-wide
hgs
parents:
diff changeset
   121
     * error codes.
hgs
parents:
diff changeset
   122
     */
hgs
parents:
diff changeset
   123
    TInt StartServer();
hgs
parents:
diff changeset
   124
    };
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
#endif // RFLEXTIMERSERVERMONITOR_H
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
// End of File