---

AbstractSemaphore.hpp

#if   !defined(__ABSTRACTSEMAPHORE_HPP)
#define  __ABSTRACTSEMAPHORE_HPP

/*
  CoreLinux++ 
  Copyright (C) 1999,2000 CoreLinux Consortium
  
   The CoreLinux++ Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The CoreLinux++ Library Library is distributed in the hope that it will 
   be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the GNU C Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  
*/

#if !defined(__COMMON_HPP)
#include <Common.hpp>
#endif

#if   !defined(__SEMAPHOREEXCEPTION_HPP)
#include <SemaphoreException.hpp>
#endif

namespace   corelinux
{

   enum SemaphoreOperationStatus
   {

      KERNELERROR=-1,


      SUCCESS=0,


      BALKED,


      TIMEDOUT,


      UNAVAILABLE
   };

   DECLARE_CLASS( SemaphoreGroup );
   DECLARE_CLASS( AbstractSemaphore );

   class AbstractSemaphore : public Synchronized
   {

   public:


      //
      // Constructors and destructors
      //

                           AbstractSemaphore
                              ( 
                                 SemaphoreGroupPtr, 
                                 SemaphoreIdentifierRef 
                              )
                              throw ( NullPointerException );


      virtual              ~AbstractSemaphore( void );

      //
      // Operator overloads
      //

               bool     operator==( AbstractSemaphoreCref aRef ) const;

      //
      // Accessors
      //


      virtual  bool  isBalkingEnabled( void ) const = 0;


      virtual  bool  isRecursionEnabled( void ) const = 0;


               SemaphoreIdentifierCref    getIdentifier( void ) const ;


               SemaphoreGroupIdentifierCref  getGroupIdentifier( void ) const;


      virtual  ThreadIdentifierCref getOwningThreadIdentifier( void ) 
                                                      const = 0;


      virtual  CounterCref    getRecursionQueueLength( void ) const = 0;


               Int   getValue( void );


               Int   getInitialValue( void );


      virtual  bool  isLocked( void ) = 0;


      //
      // Mutators
      //


      virtual  SemaphoreOperationStatus   lockWithWait( void ) 
                     throw(SemaphoreException) = 0;


      virtual  SemaphoreOperationStatus   lockWithNoWait( void )
                     throw(SemaphoreException) = 0;


//      virtual  SemaphoreOperationStatus   lockWithTimeOut( Timer ) 
//                   throw(SemaphoreException) = 0;


      virtual  SemaphoreOperationStatus   release( void ) 
                     throw(SemaphoreException) = 0;


   protected:

      //
      // Constructors
      //

                           AbstractSemaphore( AbstractSemaphoreCref ) 
                              throw(Assertion);

      //
      // Operator overloads
      //
               AbstractSemaphoreRef operator=( AbstractSemaphoreCref ) 
                              throw(Assertion);

      //
      // Accessors
      //


      inline   SemaphoreIdentifierRef   getId( void ) 
               {
                  return theSemIdentifier;
               }



      inline   Int   getGroupId( void ) const
               {
                  return theGroupIdentifier;
               }


      virtual  ThreadIdentifierRef  getOwnerId( void ) = 0;



      //
      // Mutators
      //

               SemaphoreOperationStatus   setLock( Int );


               SemaphoreOperationStatus   setUnlock( Int );


               SemaphoreOperationStatus   setValue( Int );


   private:


               SemaphoreGroupPtr    theGroup;


               Int   theGroupIdentifier;


               SemaphoreIdentifier  theSemIdentifier;

   };
}

#endif // if !defined(__ABSTRACTSEMAPHORE_HPP)

/*
   Common rcs information do not modify
   $Author: frankc $
   $Revision: 1.4 $
   $Date: 2000/07/28 01:37:09 $
   $Locker:  $
*/

---

This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium