packages/kernel/v2_0/include/mbox.hxx

   1 #ifndef CYGONCE_KERNEL_MBOX_HXX
   2 #define CYGONCE_KERNEL_MBOX_HXX
   3
   4 //==========================================================================
   5 //
   6 //      mbox.hxx
   7 //
   8 //      Plain (void *) Mbox (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 Mbox class interfaces
  50 // Description: The classes defined here provide the APIs for mboxes.
  51 // Usage:       #include <cyg/kernel/mbox.hxx>
  52 //
  53 //
  54 //####DESCRIPTIONEND####
  55 //
  56 //==========================================================================
  57
  58 #include <cyg/kernel/ktypes.h>
  59 #include <cyg/infra/cyg_ass.h>            // assertion macros
  60 #include <cyg/kernel/thread.hxx>
  61
  62 #ifdef CYGIMP_MBOX_USE_MBOXT_PLAIN
  63 #include <cyg/kernel/mboxt.hxx>
  64 #else
  65 #include <cyg/kernel/mboxt2.hxx>
  66 #endif
  67
  68 // -------------------------------------------------------------------------
  69 // Message/Mail Box.  This class implements a queue of void * items using
  70 // the Cyg_Mbox<Type, QSize> template class.
  71
  72 #ifndef CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE
  73 // default is 10 elements
  74 #define CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE (10)
  75 #endif
  76
  77 // Cyg_Mbox has a fixed size array of (void *)s; one size fits all.
  78 // Because of this, we can simplify the API by returning a NULL for
  79 // "failed" conditions.  Ergo a NULL message is illegal.  BFD.
  80
  81 class Cyg_Mbox
  82 {
  83 private:
  84 #ifdef CYGIMP_MBOX_USE_MBOXT_PLAIN
  85     Cyg_Mboxt<void *, CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE> m;
  86 #else
  87     Cyg_Mboxt2<void *, CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE> m;
  88 #endif
  89
  90 public:
  91
  92     CYGDBG_DEFINE_CHECK_THIS
  93
  94     Cyg_Mbox();                         // Constructor
  95     ~Cyg_Mbox();                        // Destructor
  96
  97     void *      get();                  // get an item; wait if none
  98 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  99     void *      get( cyg_tick_count timeout );
 100 #endif
 101     void *      tryget();               // just one attempt
 102
 103     void *      peek_item();            // Get next item to be returned
 104                                         // without removing it
 105
 106 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT   // then we support it too
 107     cyg_bool    put( void *item );      // put an item; wait if full
 108 #ifdef CYGFUN_KERNEL_THREADS_TIMER
 109     cyg_bool    put( void *item, cyg_tick_count timeout );
 110 #endif
 111 #endif
 112     cyg_bool    tryput( void *item );   // fails if Q full
 113
 114     inline
 115     cyg_count32 peek()                  // Get current count value
 116     {
 117         return m.peek();
 118     }
 119
 120     inline
 121     cyg_bool    waiting_to_get()        // Any threads waiting to get?
 122     {
 123         return m.waiting_to_get();
 124     }
 125     inline
 126     cyg_bool    waiting_to_put()        // Any threads waiting to put?
 127     {
 128         return m.waiting_to_put();
 129     }
 130 };
 131
 132
 133
 134 // -------------------------------------------------------------------------
 135 #endif // ifndef CYGONCE_KERNEL_MBOX_HXX
 136 // End of mbox.hxx