/usr/include/corelinux/SemaphoreGroup.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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | #if !defined(__SEMAPHOREGROUP_HPP)
#define __SEMAPHOREGROUP_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(__SEMAPHORECOMMON_HPP)
#include <SemaphoreCommon.hpp>
#endif
#if !defined(__ABSTRACTSEMAPHORE_HPP)
#include <AbstractSemaphore.hpp>
#endif
#if !defined(__MAP_HPP)
#include <Map.hpp>
#endif
namespace corelinux
{
const Dword NAMEBUFFERSIZE(254);
struct SemaphoreReference
{
Int theCount;
AbstractSemaphorePtr theSem;
};
CORELINUX_MAP( Index, SemaphoreReference, std::less<Index> , SemaphoreShares );
DECLARE_CLASS( SemaphoreGroup );
/**
A SemaphoreGroup is an extension to the Linux semaphore set.
This provides a way to logically group semaphores. A SemaphoreGroup
acts as a Semaphore factory, creating and destroying Semaphores
for the user.
*/
class SemaphoreGroup : public Synchronized
{
public:
/**
Default constructor creates a private group
semaphores.
@param Short Number of semaphores in group
@param AccessRights Specifies access control for
group, default is owner only.
@exception Assertion if aCount < 1
@exception SemaphoreException if kernel group
create call fails.
@see corelinux::AccessRights
*/
SemaphoreGroup( Short , Int Rights = OWNER_ALL )
throw(Assertion,SemaphoreException);
/**
Constructor to open or create a semaphore group with
a specific identifier.
@param Short Number of semaphores in group,
this only has meaning used if failOnExist = true
@param SemaphoreGroupIdentifier valid group
identifier either through a system call or via
another ipc mechanism
@param AccessRights Specifies access control for
group
@param CreateDisposition indicates how to treat the
conditions that the group may meet in the request:
CREATE_OR_REUSE indicates that the caller doesn't
care
FAIL_IF_EXISTS indicates the attempt was for a create
FAIL_IF_NOTEXISTS indicates the attempt was for a
open
@exception Assertion if aCount < 1
@exception SemaphoreException for described states
@see corelinux::AccessRights
*/
SemaphoreGroup
(
Short,
SemaphoreGroupIdentifierCref,
Int ,
CreateDisposition disp=FAIL_IF_EXISTS
) throw(Assertion,SemaphoreException);
/**
Constructor to open or create a semaphore group by
name.
@param Short Number of semaphores in group,
this only has meaning used if failOnExist = true
@param Char pointer to Group name
@param AccessRights Specifies access control for
group
@param CreateDisposition indicates how to treat the
conditions that the group may meet in the request:
CREATE_OR_REUSE indicates that the caller doesn't
care
FAIL_IF_EXISTS indicates the attempt was for a create
FAIL_IF_NOTEXISTS indicates the attempt was for a
open
@exception Assertion if aCount < 1 or
aCount > system defined maximum for group
@exception SemaphoreException for described states
@see corelinux::AccessRights
*/
SemaphoreGroup
(
Short,
CharCptr,
Int ,
CreateDisposition disp=FAIL_IF_EXISTS
) throw(Assertion,SemaphoreException);
/// Virtual destructor
virtual ~SemaphoreGroup( void );
//
// Operator overloads
//
/**
Equality operator compares the identifier
@param SemaphoreGroup a reference to SemaphoreGroup
@return bool True if equal
*/
bool operator==( SemaphoreGroupCref ) const;
//
// Accessors
//
/**
Return the number of semaphores in the group
@return Short Count
*/
Short getSemaphoreCount( void ) const;
/**
Return the SemaphoreGroupIdentifier
@return SemaphoreGroupIdentifier
*/
inline SemaphoreGroupIdentifierCref getIdentifier( void ) const
{
return theIdentifier;
}
//
// Factory methods
//
/**
Create a default semaphore type from group
@return AbstractSemaphore aSem - pointer to created semaphore
@exception SemaphoreException if no sems left in group
*/
virtual AbstractSemaphorePtr createSemaphore( void )
throw( SemaphoreException ) = 0;
/**
Create or open (use) a specific semphore in the group
@param SemaphoreIdentifier identifies which semphore id to
create or attempt to use
@param CreateDisposition indicates how to treat the conditions
that the group may meet in the request:
CREATE_OR_REUSE indicates that the caller doesn't care
FAIL_IF_EXISTS indicates the attempt was for a create
FAIL_IF_NOTEXISTS indicates the attempt was for a open
@param Recursive to allow same thread multiple locks
@param Balking to allow the semaphore to balk
@return AbstractSemaphore aSem - pointer to created or
opened semaphore
@exception SemaphoreException if the disposition disagrees
with the semaphore state, or if it is a erroneous identifier
*/
virtual AbstractSemaphorePtr createSemaphore
(
SemaphoreIdentifierRef aIdentifier,
CreateDisposition disp = CREATE_OR_REUSE,
bool Recursive=false,
bool Balking = false
) throw( SemaphoreException ) = 0;
/**
Create or open (use) a specific semphore in the group
@param string identifies which semphore id to create or
attempt to use
@param CreateDisposition indicates how to treat the conditions
that the group may meet in the request:
CREATE_OR_REUSE indicates that the caller doesn't care
FAIL_IF_EXISTS indicates the attempt was for a create
FAIL_IF_NOTEXISTS indicates the attempt was for a open
@param Recursive to allow same thread multiple locks
@param Balking to allow the semaphore to balk
@return AbstractSemaphore aSem - pointer to created or
opened semaphore
@exception SemaphoreException if the disposition disagrees
with the semaphore state, or if it is a erroneous identifier
*/
virtual AbstractSemaphorePtr createSemaphore
(
std::string aName,
CreateDisposition disp = CREATE_OR_REUSE,
bool Recursive=false,
bool Balking = false
) throw( SemaphoreException ) = 0;
/**
Destroys a created semaphore from this group.
@param AbstractSemaphore pointer of semaphore to destroy
@exception SemaphoreException if semaphore does not belong
to this group
*/
virtual void destroySemaphore( AbstractSemaphorePtr )
throw( SemaphoreException ) = 0;
protected:
//
// Constructors
//
/// Default constructor not allowed
SemaphoreGroup( void ) throw( Assertion );
/// Copy constructor not allowed
SemaphoreGroup( SemaphoreGroupCref )
throw( Assertion );
//
// Operator overloads
//
/// Assignment operator not allowed
SemaphoreGroupRef operator=( SemaphoreGroupCref )
throw( Assertion );
//
// Methods for shared control
//
/**
This indirects to CSA for non-private group
types
@param Int reference to type where 0 = Mutex, 1 = Gateway,
2 = Event, 3-10 reserved. Anything greater than 10 is
user defined.
*/
void setGroupType( IntCref ) const;
/**
Claim an unused semaphore from the group. This implies
that even though the group may be shared, the user has
elected to use privately.
*/
//
// Methods for SemaphoreGroup base
//
/// Internal check for creation visibility
inline bool isPrivate( void ) const
{
return (theGroupCSA == NULLPTR);
}
protected:
private:
friend class SemaphoreCommon;
/// The group identifier
SemaphoreGroupIdentifier theIdentifier;
/// The number of semaphores in group
Short theNumberOfSemaphores;
/// The CSA group descriptor
CSAGrpHeaderPtr theGroupCSA;
/// The name if created with one, nullptr otherwise
Char theName[NAMEBUFFERSIZE];
};
}
#endif // if !defined(__SEMAPHOREGROUP_HPP)
/*
Common rcs information do not modify
$Author: prudhomm $
$Revision: 1.9 $
$Date: 2000/08/31 22:52:20 $
$Locker: $
*/
|