systemswstubs/asyreference/inc/ASYmessage.h
branchRCL_3
changeset 44 b5894bb67e73
parent 35 37b610eb7fe3
equal deleted inserted replaced
35:37b610eb7fe3 44:b5894bb67e73
     1 /*
       
     2 * Copyright (c) 2002-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:  Used as an reference implementation
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef ASYMESSAGE_H
       
    21 #define ASYMESSAGE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32std.h>
       
    25 #include "ASYmessagedefinitions.h"
       
    26 
       
    27 // CONSTANTS
       
    28 
       
    29 // MACROS
       
    30 
       
    31 // DATA TYPES
       
    32 
       
    33 // FUNCTION PROTOTYPES
       
    34 
       
    35 // FORWARD DECLARATIONS
       
    36 
       
    37 // CLASS DECLARATION
       
    38 NONSHARABLE_CLASS( TASYMessage );
       
    39 
       
    40 /**
       
    41 *  TASYMessage
       
    42 *  This class declarates the TASYMessage, which is a generic message class example.
       
    43 *  message class.
       
    44 *
       
    45 */
       
    46 class TASYMessage
       
    47     {
       
    48     public:  // Constructors and destructor
       
    49 
       
    50         /**
       
    51         * Constructor.
       
    52         * @param aGroup         Message group.
       
    53         * @param aID            Message ID.
       
    54         * @param aData          Pointer to data.        
       
    55         */
       
    56         TASYMessage( const TUint32 aGroupId, const TUint32 aMessageId, 
       
    57                               TDesC8& aData );         
       
    58     
       
    59     public: // New functions
       
    60         
       
    61         /**
       
    62         * Returns message group
       
    63         * @return               Message group
       
    64         */
       
    65         TUint32 GroupId(); 
       
    66 
       
    67         /**
       
    68         * Returns message id
       
    69         * @return               Message id
       
    70         */
       
    71         TUint32 MessageId();
       
    72 
       
    73         /**
       
    74         * Returns message data
       
    75         * @return               Message data
       
    76         */
       
    77         TDesC8& Data();
       
    78 
       
    79 
       
    80     private:    // Data
       
    81         // Group id
       
    82         TUint32 iGroupId;
       
    83 
       
    84         // Message id
       
    85         TUint32 iMessageId;
       
    86        
       
    87         // Message data
       
    88         TDesC8& iData;
       
    89 
       
    90     };
       
    91 
       
    92 #endif      // ASYMESSAGE_H
       
    93 
       
    94 // End of File