systemswstubs/examplecommonisc/IscDriver/inc/IscSendQueue.h
changeset 0 0ce1b5ce9557
equal deleted inserted replaced
-1:000000000000 0:0ce1b5ce9557
       
     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:  An example implementation for ISC Driver Reference
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef DISCSENDQUEUE_H
       
    21 #define DISCSENDQUEUE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <kernel.h>
       
    25 #include "IscQueue.h" // Base class
       
    26 
       
    27 // CONSTANTS
       
    28 
       
    29 // MACROS
       
    30 
       
    31 // FUNCTION PROTOTYPES
       
    32 
       
    33 // FORWARD DECLARATIONS
       
    34 
       
    35 // CLASS DECLARATION
       
    36 class DIscChannel;
       
    37 class TIscSendFrameInfo;
       
    38 
       
    39 // DATA TYPES
       
    40 
       
    41 /**
       
    42 *  Generic FIFO-type class for send messages
       
    43 *
       
    44 *  @lib IscDriver.LIB
       
    45 *  @since 2.8
       
    46 */
       
    47 class DIscSendQueue : public DIscQueue
       
    48     {
       
    49     public:  // Constructors and destructor
       
    50 
       
    51         /**
       
    52         * C++ default constructor.
       
    53         */
       
    54         IMPORT_C DIscSendQueue( TUint32** aQueue, 
       
    55                                 TIscSendFrameInfo** aParameterQueue,
       
    56                                 TUint16 aSize );
       
    57 
       
    58         /**
       
    59         * Destructor.
       
    60         */
       
    61         IMPORT_C ~DIscSendQueue();
       
    62 
       
    63         /**
       
    64         * Function to add element to queue
       
    65 		* @since 2.8
       
    66         * @param anEntry pointer to frame
       
    67         * @param aId channel number
       
    68         * @param aChannelPtr DIscChannel pointer
       
    69         * @param aFrameInfo Additional information to pass information to data transmission driver
       
    70         * @return TInt KErrNone / KErrNoMemory
       
    71         */
       
    72         IMPORT_C TInt Add( TAny* anEntry, TUint16 aId, DIscChannel* aChannelPtr, TAny* aFrameInfo );
       
    73 
       
    74         /**
       
    75         * Function to get information about first frame in queue
       
    76 		* @since 2.8
       
    77         * @return TIscSendFrameInfo* (channel id, channel pointer and frameinfo)
       
    78         */
       
    79         IMPORT_C TIscSendFrameInfo* GetFirstFrameInfo();
       
    80         
       
    81 
       
    82     private:
       
    83 
       
    84         TIscSendFrameInfo**   iParameterQueue;
       
    85         
       
    86     };
       
    87 
       
    88 class TIscSendFrameInfo
       
    89     {
       
    90     public:
       
    91     DIscChannel* iChannelPtr;
       
    92     TAny*        iFrameInfo;
       
    93     TUint16      iChannelId;
       
    94     };
       
    95 
       
    96 #endif      // DISCSENDQUEUE_H
       
    97             
       
    98 // End of File