/usr/include/corelinux/AbstractSemaphore.hpp is in libcorelinux-dev 0.4.32-7.4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | #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
{
/**
Semaphore method return enumeration
*/
enum SemaphoreOperationStatus
{
/// Kernel error, errno set
KERNELERROR=-1,
/// Call success
SUCCESS=0,
/// Semaphore balked request
BALKED,
/// Semaphore request timed out
TIMEDOUT,
/// Semaphore unavailable for request
UNAVAILABLE
};
DECLARE_CLASS( SemaphoreGroup );
DECLARE_CLASS( AbstractSemaphore );
/**
A AbstractSemaphore supports the protocol that processes and/or threads
agree to follow for the purpose of controlled access to a resource. The
resource can be anything that the developer considers to need access
controls on such as memory, hardware, methods, computer instructions,
and so on.
Callers can elect to avoid being put into a blocked state and
return immediately without control to the resource. Callers may also
request that they are put into a blocked state for a specified amount
of time. If, at the end of the specified time, the request has not
been satisfied, it is returned with a Timeout indicator.
The owner or creator of the AbstractSemaphore can elect to enforce balking
behavior on a AbstractSemaphore. When so designated, the
AbstractSemaphore can turn back any request until some condition in their
solution space is met regardless of the callers blocking options. If a
caller access attempt is balked, is it returned with a Balked indicator.
*/
class AbstractSemaphore : public Synchronized
{
public:
//
// Constructors and destructors
//
/**
Default constructor
*/
AbstractSemaphore
(
SemaphoreGroupPtr,
SemaphoreIdentifierRef
)
throw ( NullPointerException );
/// Virtual Destructor
virtual ~AbstractSemaphore( void );
//
// Operator overloads
//
/// Equality operator returns true if identifiers match
bool operator==( AbstractSemaphoreCref aRef ) const;
//
// Accessors
//
/// Returns true if balking enabled
virtual bool isBalkingEnabled( void ) const = 0;
/// Returns true if recursion allowed
virtual bool isRecursionEnabled( void ) const = 0;
/// Return a reference to this AbstractSemaphore identifier
SemaphoreIdentifierCref getIdentifier( void ) const ;
/// Returns a reference to the SemaphoreGroup identifier
SemaphoreGroupIdentifierCref getGroupIdentifier( void ) const;
/// Returns the identifier of who currently owns the semaphore
virtual ThreadIdentifierCref getOwningThreadIdentifier( void )
const = 0;
/// Return the depth of the recursion for the owner
virtual CounterCref getRecursionQueueLength( void ) const = 0;
/// Returns the current value of the semaphore
Int getValue( void );
/// Retrieves the initial value for a semaphore
Int getInitialValue( void );
/// Ask if AbstractSemaphore instance is locked
virtual bool isLocked( void ) = 0;
//
// Mutators
//
/// Request the lock, wait for availability
virtual SemaphoreOperationStatus lockWithWait( void )
throw(SemaphoreException) = 0;
/// Request the lock without waiting
virtual SemaphoreOperationStatus lockWithNoWait( void )
throw(SemaphoreException) = 0;
/// Request the AbstractSemaphore but timeout if not available
// virtual SemaphoreOperationStatus lockWithTimeOut( Timer )
// throw(SemaphoreException) = 0;
/// Release the lock
virtual SemaphoreOperationStatus release( void )
throw(SemaphoreException) = 0;
protected:
//
// Constructors
//
AbstractSemaphore( AbstractSemaphoreCref )
throw(Assertion);
//
// Operator overloads
//
AbstractSemaphoreRef operator=( AbstractSemaphoreCref )
throw(Assertion);
//
// Accessors
//
/// Returns a reference to the AbstractSemaphore identifier
inline SemaphoreIdentifierRef getId( void )
{
return theSemIdentifier;
}
/// Returns a reference to the group identifier
inline Int getGroupId( void ) const
{
return theGroupIdentifier;
}
/// Returns a reference to the owning thread
virtual ThreadIdentifierRef getOwnerId( void ) = 0;
//
// Mutators
//
/// Calls kernel lock mechanism
SemaphoreOperationStatus setLock( Int );
/// Calls kernel unlock mechanism
SemaphoreOperationStatus setUnlock( Int );
/// Calls kernel zero mechanism
SemaphoreOperationStatus waitZero( Int );
/// Sets the value for the AbstractSemaphore
SemaphoreOperationStatus setValue( Int );
private:
/// The group of instance origination
SemaphoreGroupPtr theGroup;
/// The group instance identifier
Int theGroupIdentifier;
/// The thread identifier
SemaphoreIdentifier theSemIdentifier;
};
}
#endif // if !defined(__ABSTRACTSEMAPHORE_HPP)
/*
Common rcs information do not modify
$Author: dulimart $
$Revision: 1.5 $
$Date: 2000/09/09 06:54:53 $
$Locker: $
*/
|