1 /*

     2 * Copyright (c) 2004 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:  Types used in PhoneServer Messenger related functionality.

    15 *

    16 */

    17 

    18 

    19 #ifndef PHSRVMESSENGERTYPES_H

    20 #define PHSRVMESSENGERTYPES_H

    21 

    22 

    23 // INCLUDES

    24 #include <CPhCltMessenger.h>

    25 

    26 // DATA TYPES

    27 

    28 

    29 /**

    30 * The Messenger parameters defined as in one class.

    31 * The handler of received messenger request must first check the

    32 * performed request, and then read the appropriate parameters.

    33 * 

    34 * @since 2.6

    35 */

    36 class TPhSrvMessengerParameters

    37     {

    38     public:  // Constructors and destructor

    39 

    40         /**

    41         * C++ constructor.

    42         * Set the default parameter values. 

    43         */

    44         inline TPhSrvMessengerParameters() :

    45             iMessengerCommand( EPhCltMesCommandUnknown ), 

    46             iDefaultMessageSize( 0 ),

    47             iSendMessagePtr( NULL ),

    48             iSendPayloadLength( 0 ),

    49             iSendDataValid( EFalse ),

    50             iSentDataId( 0 ),

    51             iReceiveBufferMaxSize( 0 ),

    52             iReceiveDataValid( EFalse ),

    53             iSkipNextMessage( EFalse ),

    54             iSkippedSentDataId( 0 )

    55             {

    56             iCategoryUid = TUid::Uid( 0 );

    57             }

    58 

    59 

    60     public:    // Data  

    61 

    62         // The Messenger Negotiator command.

    63         TPhCltMessengerCommand  iMessengerCommand;

    64 

    65         // The message types that are listened.

    66         TUid                    iCategoryUid;

    67 

    68         // The default message size.

    69         TInt                    iDefaultMessageSize;

    70 

    71 

    72         // The Send message payload.

    73         const TDesC8*           iSendMessagePtr;

    74 

    75         // The length of the sent message.

    76         TInt                    iSendPayloadLength;

    77 

    78         // Tells whether send data is valid or not.

    79         TBool                   iSendDataValid;

    80 

    81         // The Send message status to be completed when ready.

    82         RMessage2               iSendStatus;

    83 

    84         // The ID of the sent message.

    85         TUint                   iSentDataId;

    86 

    87         // The maximum size of the receive buffer.

    88         TInt                    iReceiveBufferMaxSize;

    89         // The Receive message parameters.

    90         //TPhCltMessengerParameters iReceiveParameters;

    91 

    92         // Tells whether receive data is valid or not.

    93         TBool                   iReceiveDataValid;

    94 

    95         // The Receive message status, size and payload 

    96         // to be completed when ready.

    97         RMessage2               iReceiveMessage;

    98 

    99 

   100         // Is the next Sent message Skipped?

   101         TBool                   iSkipNextMessage;

   102 

   103         // The ID of the Skipped message.

   104         TUint                   iSkippedSentDataId;

   105 

   106     };

   107 

   108 #endif // PHSRVMESSENGERTYPES_H

   109 

   110 // End of File