packages/kernel/v2_0/include/mboxt2.hxx

   1 #ifndef CYGONCE_KERNEL_MBOXT2_HXX
   2 #define CYGONCE_KERNEL_MBOXT2_HXX
   3
   4 //==========================================================================
   5 //
   6 //      mboxt2.hxx
   7 //
   8 //      Mboxt2 (Message Box/Mailbox) class declarations
   9 //
  10 //==========================================================================
  11 //####ECOSGPLCOPYRIGHTBEGIN####
  12 // -------------------------------------------
  13 // This file is part of eCos, the Embedded Configurable Operating System.
  14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  15 //
  16 // eCos is free software; you can redistribute it and/or modify it under
  17 // the terms of the GNU General Public License as published by the Free
  18 // Software Foundation; either version 2 or (at your option) any later version.
  19 //
  20 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  21 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  22 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  23 // for more details.
  24 //
  25 // You should have received a copy of the GNU General Public License along
  26 // with eCos; if not, write to the Free Software Foundation, Inc.,
  27 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  28 //
  29 // As a special exception, if other files instantiate templates or use macros
  30 // or inline functions from this file, or you compile this file and link it
  31 // with other works to produce a work based on this file, this file does not
  32 // by itself cause the resulting work to be covered by the GNU General Public
  33 // License. However the source code for this file must still be made available
  34 // in accordance with section (3) of the GNU General Public License.
  35 //
  36 // This exception does not invalidate any other reasons why a work based on
  37 // this file might be covered by the GNU General Public License.
  38 //
  39 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  40 // at http://sources.redhat.com/ecos/ecos-license/
  41 // -------------------------------------------
  42 //####ECOSGPLCOPYRIGHTEND####
  43 //==========================================================================
  44 //#####DESCRIPTIONBEGIN####
  45 //
  46 // Author(s):   hmt
  47 // Contributors:        hmt
  48 // Date:        1998-02-10
  49 // Purpose:     Define Mboxt2 class interfaces
  50 // Description: The classes defined here provide the APIs for mboxt2es.
  51 // Usage:       #include <cyg/kernel/mboxt2.hxx>
  52 //              #include <cyg/kernel/mboxt2.inl>
  53 //
  54 //
  55 //####DESCRIPTIONEND####
  56 //
  57 //==========================================================================
  58
  59 #include <cyg/kernel/ktypes.h>
  60 #include <cyg/infra/cyg_ass.h>            // assertion macros
  61 #include <cyg/kernel/thread.hxx>
  62 #include <cyg/kernel/thread.inl>
  63
  64 // -------------------------------------------------------------------------
  65 // Message/Mail Box.  This template implements a queue of T's.
  66 // Implemented as a template for maximal flexibility; one would hope
  67 // that only one, with T==(void *) and the same number of them,
  68 // is ever used without very good reason.
  69
  70 // Cyg_Mboxt2 has a fixed size array of T's; one size fits all.
  71
  72 template <class T, cyg_count32 QUEUE_SIZE>
  73 class Cyg_Mboxt2
  74 {
  75 private:
  76     cyg_count32         base;           // index of first used slot
  77     cyg_count32         count;          // count of used slots
  78     Cyg_ThreadQueue     get_threadq;    // Queue of waiting threads
  79 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
  80     Cyg_ThreadQueue     put_threadq;    // Queue of waiting threads
  81 #endif
  82     static const
  83     cyg_count32         size = QUEUE_SIZE;
  84     T                   itemqueue[ QUEUE_SIZE ];
  85                                         // queue of items
  86     // private utility functions
  87     // wake up a thread from some queue
  88     inline void         wakeup_winner( const T &msg );
  89 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
  90     inline void         wakeup_putter( void );
  91 #endif
  92
  93 public:
  94
  95     CYGDBG_DEFINE_CHECK_THIS
  96
  97     Cyg_Mboxt2();                        // Constructor
  98     ~Cyg_Mboxt2();                       // Destructor
  99
 100     cyg_bool    get( T &ritem );        // get an item; wait if none
 101 #ifdef CYGFUN_KERNEL_THREADS_TIMER
 102     cyg_bool    get( T &ritem, cyg_tick_count abs_timeout );
 103 #endif
 104     cyg_bool    tryget( T &ritem );     // just one attempt
 105
 106     cyg_bool    peek_item( T &ritem );  // get next item without
 107                                         // removing it
 108
 109 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
 110     cyg_bool    put( const T item );    // put an item; wait if full
 111 #ifdef CYGFUN_KERNEL_THREADS_TIMER
 112     cyg_bool    put( const T item, cyg_tick_count abs_timeout );
 113 #endif
 114 #endif
 115     cyg_bool    tryput( const T item ); // fails if Q full
 116
 117     inline
 118     cyg_count32 peek()                  // Get current count value
 119     {
 120         return count;
 121     }
 122
 123     inline
 124     cyg_bool    waiting_to_get()        // Any threads waiting?
 125     {
 126         return ! get_threadq.empty();
 127     }
 128
 129     inline
 130     cyg_bool    waiting_to_put()        // Any threads waiting?
 131     {
 132 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
 133         return ! put_threadq.empty();
 134 #else
 135         return false;
 136 #endif
 137     }
 138 };
 139
 140 // -------------------------------------------------------------------------
 141 #endif // ifndef CYGONCE_KERNEL_MBOXT2_HXX
 142 // EOF mboxt2.hxx