bluetoothengine/headsetsimulator/core/inc/Plugin/hsprofilepluginbase.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 HSPROFILEBASE_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    17
#define HSPROFILEBASE_H_
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    18
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    19
#include <e32cmn.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    20
#include <badesca.h>
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    21
#include <ecom.h> 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    22
#include <hsecompluginbase.h>
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
 * Profile plugin's UID
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    26
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    27
const TUid KHsProfileBaseInterfaceDefinitionUid =
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    28
    {
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    29
    0xE0009DC1
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    30
    };
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    31
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    32
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    33
 * @brief Abstract methods for profile plugin
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    34
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    35
class MHsProfileBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    36
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    37
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    38
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    39
     * Destructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    40
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    41
    virtual ~MHsProfileBase() {  };
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    42
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    43
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    44
     * Profile's method for handling AT Commands
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    45
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    46
     * @param aCommandsIn AT command received by HS
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    47
     * @param aCommandsOut response
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    48
     * @param aFromAG denotes if AT command was sent from AG
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    49
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    50
    virtual void HandleCommandL( const TDesC8& aCommandsIn, TDes8& aCommandsOut,
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    51
            const TBool aFromAG = ETrue ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    52
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    53
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    54
     * Profile's method for handling AG client disconnection
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    55
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    56
     * @param aErr disconnection reason
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    57
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    58
    virtual void HandleClientDisconnected( TInt aErr ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    59
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    60
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    61
     * Profile's method for handling AG client connection
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    62
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    63
     * @param aCommandOut response
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    64
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    65
    virtual void HandleClientConnected( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    66
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    67
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    68
     * Profile's method for accepting incoming call
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    69
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    70
     * @param aCommandOut response
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    71
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    72
    virtual void HandleAcceptCallL( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    73
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    74
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    75
     * Profile's method for releasing ongoing call
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    76
     * 
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    77
     * @param aCommandOut response
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    78
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    79
    virtual void HandleReleaseCallL( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    80
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    81
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    82
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    83
/**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    84
 * @brief Base class for profile plugins
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    85
 */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    86
class CHsProfileBase : public CHsEComPluginBase, public MHsProfileBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    87
{
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    88
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    89
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    90
     * Two-phase constructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    91
     * @param aUid plugin's UID
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    92
     * @return instance of class
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    93
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    94
    static CHsProfileBase* NewL( const TUid aUid );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    95
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    96
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    97
     * Two-phase constructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    98
     * @param aProfileName plugin's name
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
    99
     * @return instance of class
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   100
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   101
    static CHsProfileBase* NewL( const TDesC8 &aProfileName );
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   102
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   103
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   104
    /**
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   105
     * Destructor
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   106
     */
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   107
    virtual ~CHsProfileBase();
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   108
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   109
public:
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   110
    //Methods inherited  from MHsProfileBase
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   111
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   112
    virtual void HandleCommandL( const TDesC8 &aCommandsIn, TDes8 &aCommandsOut,
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   113
            const TBool aFromAG = ETrue ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   114
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   115
    virtual void HandleClientDisconnected( TInt aErr ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   116
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   117
    virtual void HandleClientConnected( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   118
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   119
    virtual void HandleAcceptCallL( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   120
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   121
    virtual void HandleReleaseCallL( TDes8& aCommandOut ) = 0;
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   122
};
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   123
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   124
#include "hsprofilepluginbase.inl"
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   125
90dbfc0435e3 source code commit
michal.sulewski
parents:
diff changeset
   126
#endif /* HSPROFILEBASE_H_ */