packages/kernel/v2_0/include/sema.hxx

   1 #ifndef CYGONCE_KERNEL_SEMA_HXX
   2 #define CYGONCE_KERNEL_SEMA_HXX
   3
   4 //==========================================================================
   5 //
   6 //      sema.hxx
   7 //
   8 //      Semaphore 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):   nickg
  47 // Contributors:        nickg
  48 // Date:        1997-09-09
  49 // Purpose:     Define Semaphore class interfaces
  50 // Description: The classes defined here provide the APIs for binary
  51 //              and counting semaphores.
  52 // Usage:       #include <cyg/kernel/sema.hxx>
  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.inl>       // thread inlines
  62
  63 // -------------------------------------------------------------------------
  64 // Binary semaphore. This has only two states: posted and not-posted.
  65
  66 class Cyg_Binary_Semaphore
  67 {
  68     cyg_bool            state;          // The binary semaphore state
  69
  70     Cyg_ThreadQueue     queue;          // Queue of waiting threads
  71
  72 public:
  73
  74     CYGDBG_DEFINE_CHECK_THIS
  75
  76     Cyg_Binary_Semaphore(               // Constructor
  77         cyg_bool init_state = false     // Initial state value
  78         );
  79
  80     ~Cyg_Binary_Semaphore();            // Destructor
  81
  82     cyg_bool    wait();                 // Wait until state == true
  83
  84 #ifdef CYGFUN_KERNEL_THREADS_TIMER
  85     cyg_bool    wait( cyg_tick_count timeout );
  86 #endif                                  // Wait until state == true or timeout
  87
  88     cyg_bool    trywait();              // Set state false if possible
  89
  90     void        post();                 // Increment count
  91
  92     cyg_bool    posted();               // Get current state
  93
  94 };
  95
  96 // -------------------------------------------------------------------------
  97 // Counting semaphore. This implements the usual counter based semaphore.
  98
  99 class Cyg_Counting_Semaphore
 100 {
 101     cyg_count32         count;          // The semaphore count
 102
 103     Cyg_ThreadQueue     queue;          // Queue of waiting threads
 104
 105 public:
 106
 107     CYGDBG_DEFINE_CHECK_THIS
 108
 109     Cyg_Counting_Semaphore(             // Constructor
 110         cyg_count32 init_count = 0      // Initial count value
 111         );
 112
 113     ~Cyg_Counting_Semaphore();          // Destructor
 114
 115     cyg_bool    wait();                 // Wait until decrement
 116
 117 #ifdef CYGFUN_KERNEL_THREADS_TIMER
 118     cyg_bool    wait( cyg_tick_count timeout );
 119 #endif                                  // Wait until decrement or timeout
 120
 121     cyg_bool    trywait();              // Try to decrement
 122
 123     void        post();                 // Increment count
 124
 125     cyg_count32 peek() const;           // Get current count value
 126
 127     inline
 128     cyg_bool    waiting()               // Is anyone waiting?
 129     {
 130         return !queue.empty();
 131     }
 132
 133 };
 134
 135 // -------------------------------------------------------------------------
 136 #endif // ifndef CYGONCE_KERNEL_SEMA_HXX
 137 // EOF sema.hxx