packages/kernel/v2_0/include/mboxt.hxx

   1 #ifndef CYGONCE_KERNEL_MBOXT_HXX
   2 #define CYGONCE_KERNEL_MBOXT_HXX
   3
   4 //==========================================================================
   5 //
   6 //      mboxt.hxx
   7 //
   8 //      Mboxt (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 Mboxt class interfaces
  50 // Description: The classes defined here provide the APIs for mboxtes.
  51 // Usage:       #include <cyg/kernel/mboxt.hxx>
  52 //              #include <cyg/kernel/mboxt.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
  63 // -------------------------------------------------------------------------
  64 // Message/Mail Box.  This template implements a queue of T's.
  65 // Implemented as a template for maximal flexibility; one would hope
  66 // that only one, with T==(void *) and the same number of them,
  67 // is ever used without very good reason.
  68
  69 // Cyg_Mboxt has a fixed size array of T's; one size fits all.
  70
  71 template <class T, cyg_count32 QUEUE_SIZE>
  72 class Cyg_Mboxt
  73 {
  74 private:
  75     cyg_count32         base;           // index of first used slot
  76     cyg_count32         count;          // count of used slots
  77     Cyg_ThreadQueue     get_threadq;    // Queue of waiting threads
  78 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
  79     Cyg_ThreadQueue     put_threadq;    // Queue of waiting threads
  80 #endif
  81     static const
  82     cyg_count32         size = QUEUE_SIZE;
  83     T                   itemqueue[ QUEUE_SIZE ];
  84                                         // queue of items
  85     // private utility functions
  86     // wake up a thread from some queue
  87     inline void         wakeup_waiter( Cyg_ThreadQueue &q );
  88
  89 public:
  90
  91     CYGDBG_DEFINE_CHECK_THIS
  92
  93     Cyg_Mboxt();                        // Constructor
  94     ~Cyg_Mboxt();                       // Destructor
  95
  96     cyg_bool    get( T &ritem );        // get an item; wait if none
  97 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  98     cyg_bool    get( T &ritem, cyg_tick_count abs_timeout );
  99 #endif
 100     cyg_bool    tryget( T &ritem );     // just one attempt
 101
 102     cyg_bool    peek_item( T &ritem );  // get next item without
 103                                         // removing it
 104
 105 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
 106     cyg_bool    put( const T item );    // put an item; wait if full
 107 #ifdef CYGFUN_KERNEL_THREADS_TIMER
 108     cyg_bool    put( const T item, cyg_tick_count abs_timeout );
 109 #endif
 110 #endif
 111     cyg_bool    tryput( const T item ); // fails if Q full
 112
 113     inline
 114     cyg_count32 peek()                  // Get current count value
 115     {
 116         return count;
 117     }
 118
 119     inline
 120     cyg_bool    waiting_to_get()        // Any threads waiting?
 121     {
 122         return ! get_threadq.empty();
 123     }
 124
 125     inline
 126     cyg_bool    waiting_to_put()        // Any threads waiting?
 127     {
 128 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
 129         return ! put_threadq.empty();
 130 #else
 131         return false;
 132 #endif
 133     }
 134 };
 135
 136 // -------------------------------------------------------------------------
 137 #endif // ifndef CYGONCE_KERNEL_MBOXT_HXX
 138 // EOF mboxt.hxx