1 /*

     2 * Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Client-Server message passing declarations

    15 *

    16 */

    17 

    18 

    19 #ifndef C_ATEXTCLIENTSRV_H

    20 #define C_ATEXTCLIENTSRV_H

    21 

    22 /**  Opcodes used in message passing between client and server */

    23 enum TATExtIpc

    24     {

    25     EATExtSetExtensionInterface,

    26     EATExtSynchronousClose,

    27     EATExtHandleCommand,

    28     EATExtCancelHandleCommand,

    29     EATExtGetNextPartOfReply,

    30     EATExtNumberOfPlugins,

    31     EATExtReceiveUnsolicitedResult,

    32     EATExtCancelReceiveUnsolicitedResult,

    33     EATExtMarkUrcHandlingOwnership,

    34     EATExtReceiveEcomPluginChange,

    35     EATExtCancelReceiveEcomPluginChange,

    36     EATExtReportQuietModeChange,

    37     EATExtReportVerboseModeChange,

    38     EATExtReportCharacterChange,

    39     EATExtReportListenerUpdateReady,

    40     EATExtBroadcastNvramStatusChange,

    41     EATExtReportExternalHandleCommandError,

    42     EATExtReportHandleCommandAbort,

    43     EATExtGetNextSpecialCommand,

    44     EInvalidIpc

    45     };

    46 

    47 /**  Message parameter indexes for client side */

    48 enum TATExtClientMessages

    49     {

    50     // Parameters for Connect()

    51     EATExtConnectParamUid                   = 0,

    52     EATExtConnectParamName                  = 1,

    53     // Parameters for HandleCommand()

    54     EATExtHandleCmdParamCmd                 = 0,

    55     EATExtHandleCmdParamReply               = 1,

    56     EATExtHandleCmdParamLength              = 2,

    57     EATExtHandleCmdParamReplyType           = 3,

    58     // Parameters for GetNextPartOfReply()

    59     EATExtGetNextPartOfReplyParamReply      = 0,

    60     EATExtGetNextPartOfReplyParamLength     = 1,

    61     // Parameters for ReceiveUnsolicitedResult()

    62     EATExtReceiveUrcCmdParamBuf             = 0,

    63     EATExtReceiveUrcCmdParamUid             = 1,

    64     // Parameters for CancelReceiveUnsolicitedResult()

    65     EATExtCancelReceiveUrcCmdParamUid       = 0,

    66     // Parameters for MarkUrcHandlingOwnership()

    67     EATExtMarkUrcHandlingOwnershipParamUid  = 0,

    68     // Parameters for ReceiveEcomPluginChange()

    69     EATExtReceiveEcomPluginChangeParamUid   = 0,

    70     EATExtReceiveEcomPluginChangeParamType  = 1,

    71     // Parameters for ReportQuietModeChange()

    72     EATExtReportQuietModeChangeParamMode    = 0,

    73     // Parameters for ReportVerboseModeChange()

    74     EATExtReportVerboseModeChangeParamMode  = 0,

    75     // Parameters for ReportCharacterChange()

    76     EATExtReportCharacterChangeParamType    = 0,

    77     EATExtReportCharacterChangeParamChar    = 1,

    78     // Parameters for ReportListenerUpdateReady()

    79     EATExtReportListenerUpdateParamUid      = 0,

    80     EATExtReportListenerUpdateParamType     = 1,

    81     // Parameters for BroadcastNvramStatusChange()

    82     EATExtBroadcastNvramChangeParamNvram    = 0,

    83     // Parameters for ReportHandleCommandAbort()

    84     EATExtReportHandleCommandAbortParamStop = 0,

    85     // Parameters for GetNextSpecialCommand()

    86     EATExtGetNextSpecialCmdParamCmd         = 0,

    87     EATExtGetNextSpecialCmdParamFirst       = 1

    88     };

    89 

    90 /**  Server name */

    91 _LIT( KATExtSrvName, "atext" );

    92 

    93 /**  A version must be specified when creating a session with the server */

    94 const TUint KServerMajorVersionNumber = 1;

    95 const TUint KServerMinorVersionNumber = 0;

    96 const TUint KServerBuildVersionNumber = 0;

    97 

    98 #endif  // C_ATEXTCLIENTSRV_H