bluetoothengine/headsetsimulator/core/inc/RemoteControl/hsremotecontroldatahandler.h
author michal.sulewski
Wed, 15 Sep 2010 15:59:44 +0200
branchheadsetsimulator
changeset 60 90dbfc0435e3
permissions -rw-r--r--
source code commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
60
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     1
/*
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     2
 * Component Name: Headset Simulator
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     3
 * Author: Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     4
 * Version: 1.0
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     5
 * Copyright (c) 2010 Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     6
 *  
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     7
 * This Software is submitted by Comarch S.A. to Symbian Foundation Limited on 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     8
 * the basis of the Member Contribution Agreement entered between Comarch S.A. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
     9
 * and Symbian Foundation Limited on 5th June 2009 (“Agreement”) and may be 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    10
 * used only in accordance with the terms and conditions of the Agreement. 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    11
 * Any other usage, duplication or redistribution of this Software is not 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    12
 * allowed without written permission of Comarch S.A.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    13
 * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    14
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    15
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    16
#ifndef HSREMOTECONTROLDATAHANDLER_H
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    17
#define HSREMOTECONTROLDATAHANDLER_H
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    18
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    19
#include <e32base.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    20
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    21
class THsRemoteControlCommand;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    22
class CHsRemoteControlParser;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    23
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    24
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    25
 * @brief Manages remote requests
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    26
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    27
class CHsRemoteControlDataHandler : public CBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    28
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    29
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    30
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    31
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    32
     * Two-phased constructor.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    33
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    34
     * @return class instance
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    35
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    36
    static CHsRemoteControlDataHandler* NewL();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    37
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    38
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    39
     * Two-phased constructor.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    40
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    41
     * @return class instance
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    42
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    43
    static CHsRemoteControlDataHandler* NewLC();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    44
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    45
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    46
     * Destructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    47
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    48
    ~CHsRemoteControlDataHandler();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    49
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    50
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    51
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    52
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    53
     * Transforms remote requests into THsRemoteControlCommand objects
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    54
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    55
     * @param aDataIn remote request read from socket
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    56
     * @param aCmd THsRemoteControlCommand object
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    57
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    58
     * @return error code.
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    59
     *      KErrNone if OK
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    60
     *      KErrArgument if command not valid or not supported
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    61
     *      KErrGeneral, KErrOverflow if error in parsing
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    62
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    63
    TInt RecognizeCommand( const TDesC8& aDataIn, 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    64
            THsRemoteControlCommand& aCmd );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    65
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    66
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    67
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    68
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    69
     * Constructor for performing 1st stage construction
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    70
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    71
    CHsRemoteControlDataHandler();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    72
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    73
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    74
     * Constructor for performing 2nd stage construction
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    75
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    76
    void ConstructL();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    77
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    78
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    79
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    80
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    81
     * Checks if command is supported
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    82
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    83
     * @param aCmd command to be checked
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    84
     * @return ETrue if OK, otherwise EFalse
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    85
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    86
    TBool IsCommandValid( THsRemoteControlCommand& aCmd );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    87
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    88
private:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    89
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    90
    /** Pointer to parser. Owned */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    91
    CHsRemoteControlParser* iParser;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    92
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    93
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    94
#endif // HSREMOTECONTROLDATAHANDLER_H