localconnectivityservice/modematplugin/inc/cmdpluginobserver.h
author hgs
Fri, 23 Apr 2010 23:16:31 +0300
changeset 25 c4f07256ff37
permissions -rw-r--r--
201003
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
25
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 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:  Handles the commands "AT+COPS=..." and "AT+COPS?"
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef M_CMDPLUGINOBSERVER_H
hgs
parents:
diff changeset
    20
#define M_CMDPLUGINOBSERVER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
enum TCharacterTypes
hgs
parents:
diff changeset
    24
    {
hgs
parents:
diff changeset
    25
    ECharTypeCR,  // Carriage return
hgs
parents:
diff changeset
    26
    ECharTypeLF,  // Line feed
hgs
parents:
diff changeset
    27
    ECharTypeBS   // Backspace
hgs
parents:
diff changeset
    28
    };
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
enum TModeTypes
hgs
parents:
diff changeset
    31
    {
hgs
parents:
diff changeset
    32
    EModeTypeQuiet,   // Quiet mode
hgs
parents:
diff changeset
    33
    EModeTypeVerbose  // Verbose mode
hgs
parents:
diff changeset
    34
    };
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/**
hgs
parents:
diff changeset
    38
 *  Class for accessing plugin information and common functionality
hgs
parents:
diff changeset
    39
 *
hgs
parents:
diff changeset
    40
 *  @since S60 v5.0
hgs
parents:
diff changeset
    41
 */
hgs
parents:
diff changeset
    42
NONSHARABLE_CLASS( MCmdPluginObserver )
hgs
parents:
diff changeset
    43
    {
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
public:
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
    /**
hgs
parents:
diff changeset
    48
     * Creates an AT command reply based on the reply type and completes the
hgs
parents:
diff changeset
    49
     * request to ATEXT. Uses iReplyBuffer for reply storage.
hgs
parents:
diff changeset
    50
     *
hgs
parents:
diff changeset
    51
     * @since TB9.2
hgs
parents:
diff changeset
    52
     * @param aReplyType Type of reply
hgs
parents:
diff changeset
    53
     * @param aDstBuffer Destination buffer; used for the API requiring the
hgs
parents:
diff changeset
    54
     *                   AT command reply
hgs
parents:
diff changeset
    55
     * @param aSrcBuffer Source buffer; used only if aReplyType is EReplyTypeOther
hgs
parents:
diff changeset
    56
     * @param aError Completion code. If not KErrNone then other arguments are
hgs
parents:
diff changeset
    57
     *               ignored and the request is completed to ATEXT with
hgs
parents:
diff changeset
    58
     *               EReplyTypeUndefined.
hgs
parents:
diff changeset
    59
     * @return None
hgs
parents:
diff changeset
    60
     */
hgs
parents:
diff changeset
    61
    virtual TInt CreateReplyAndComplete( TATExtensionReplyType aReplyType,
hgs
parents:
diff changeset
    62
                                         const TDesC8& aSrcBuffer=KNullDesC8,
hgs
parents:
diff changeset
    63
                                         TInt aError=KErrNone ) = 0;
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
    /**
hgs
parents:
diff changeset
    66
     * Creates a buffer for "OK" or "ERROR" reply based on the line settings
hgs
parents:
diff changeset
    67
     *
hgs
parents:
diff changeset
    68
     * @since TB9.2
hgs
parents:
diff changeset
    69
     * @param aReplyBuffer Destination buffer for the created reply
hgs
parents:
diff changeset
    70
     * @param aOkReply ETrue if "OK" reply needed,
hgs
parents:
diff changeset
    71
     *                 EFalse if "ERROR" reply needed
hgs
parents:
diff changeset
    72
     * @return Symbian error code on error, KErrNone otherwise
hgs
parents:
diff changeset
    73
     */
hgs
parents:
diff changeset
    74
    virtual TInt CreateOkOrErrorReply( RBuf8& aReplyBuffer,
hgs
parents:
diff changeset
    75
                                       TBool aOkReply ) = 0;
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * Returns the array of supported commands
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * @since TB9.2
hgs
parents:
diff changeset
    81
     * @param aCmd Array of supported commands
hgs
parents:
diff changeset
    82
     * @return Symbian error code on error, KErrNone otherwise
hgs
parents:
diff changeset
    83
     */
hgs
parents:
diff changeset
    84
    virtual TInt GetSupportedCommands( RPointerArray<HBufC8>& aCmds ) = 0;
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
    /**
hgs
parents:
diff changeset
    87
     * Returns plugin's character value settings (from CATExtPluginBase)
hgs
parents:
diff changeset
    88
     *
hgs
parents:
diff changeset
    89
     * @since TB9.2
hgs
parents:
diff changeset
    90
     * @param aCharType Character's type
hgs
parents:
diff changeset
    91
     * @param aChar Character's value matching aCharType
hgs
parents:
diff changeset
    92
     * @return Symbian error code on error, KErrNone otherwise
hgs
parents:
diff changeset
    93
     */
hgs
parents:
diff changeset
    94
    virtual TInt GetCharacterValue( TCharacterTypes aCharType, TChar& aChar ) = 0;
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    /**
hgs
parents:
diff changeset
    97
     * Returns plugin's mode value settings (from CATExtPluginBase)
hgs
parents:
diff changeset
    98
     *
hgs
parents:
diff changeset
    99
     * @since TB9.2
hgs
parents:
diff changeset
   100
     * @param aModeType Mode type
hgs
parents:
diff changeset
   101
     * @param aMode Mode value matching aModeType
hgs
parents:
diff changeset
   102
     * @return Symbian error code on error, KErrNone otherwise
hgs
parents:
diff changeset
   103
     */
hgs
parents:
diff changeset
   104
    virtual TInt GetModeValue( TModeTypes aModeType, TBool& aMode ) = 0;
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
    };
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
#endif  // M_CMDPLUGINOBSERVER_H