mirror of
https://github.com/gnustep/libs-performance.git
synced 2025-02-19 10:01:20 +00:00
60dd3485ec
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/performance/trunk@38156 72102866-910b-0410-8b05-ffd578937521
103 lines
3.7 KiB
Objective-C
103 lines
3.7 KiB
Objective-C
#if !defined(INCLUDED_GSIOTHREADPOOL)
|
|
#define INCLUDED_GSIOTHREADPOOL 1
|
|
/**
|
|
Copyright (C) 2010 Free Software Foundation, Inc.
|
|
|
|
Written by: Richard Frith-Macdonald <rfm@gnu.org>
|
|
Date: September 2010
|
|
|
|
This file is part of the Performance Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 3 of the License, or (at your option) any later version.
|
|
|
|
This 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
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free
|
|
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
|
|
*/
|
|
#import <Foundation/NSObject.h>
|
|
|
|
#if !defined (GNUSTEP) && (MAC_OS_X_VERSION_MAX_ALLOWED<=MAC_OS_X_VERSION_10_4)
|
|
typedef unsigned int NSUInteger;
|
|
#endif
|
|
|
|
@class NSThread;
|
|
@class NSLock;
|
|
|
|
/** This class provides a thread pool for performing methods which need to
|
|
* make use of a runloop for I/O and/or timers.<br />
|
|
* Operations are performed on these threads using the standard
|
|
* -performSelector:onThread:withObject:waitUntilDone: method ... the
|
|
* pool is simply used to keep track of allocation of threads so that
|
|
* you can share jobs between them.<br />
|
|
* NB. The threading API in OSX 10.4 and earlier is incapable of supporting
|
|
* this functionality ... in that case this class cannot be instantiated
|
|
* and initialised.
|
|
*/
|
|
@interface GSIOThreadPool : NSObject
|
|
{
|
|
NSLock *poolLock;
|
|
NSMutableArray *threads;
|
|
NSTimeInterval timeout;
|
|
NSUInteger maxThreads;
|
|
}
|
|
|
|
/** Returns an instance intended for sharing between sections of code which
|
|
* wish to make use of threading by performing operations in other threads,
|
|
* but which don't mind operations being interleaved with those belonging to
|
|
* other sections of code.<br />
|
|
* Always returns the same instance whenever the method is called.<br />
|
|
* The shared pool is created with an initial size as specified by the
|
|
* GSIOThreadPoolSize user default (zero if there is no such positive
|
|
* integer in the defauilts system), however you can modify that using
|
|
* the -setThreads: method.
|
|
*/
|
|
+ (GSIOThreadPool*) sharedPool;
|
|
|
|
/** Selects a thread from the pool to be used for some job.
|
|
*/
|
|
- (NSThread*) acquireThread;
|
|
|
|
/** Returns the acquire count for the specified thread.
|
|
*/
|
|
- (NSUInteger) countForThread: (NSThread*)aThread;
|
|
|
|
/** Returns the currently configured maximum number of threads in the pool.
|
|
*/
|
|
- (NSUInteger) maxThreads;
|
|
|
|
/** Specify the maximum number of threads in the pool (the actual number
|
|
* used may be lower than this value).<br />
|
|
* Default is 0 (no thread pooling in use).<br />
|
|
* The pool creates threads on demand up to the specified limit (or a lower
|
|
* limit if dictated by system resources) but will not destroy idle threads
|
|
* unless the limit is subsequently lowered.<br />
|
|
* Setting a value of zero means that operations are performed in the
|
|
* main thread.
|
|
*/
|
|
- (void) setThreads: (NSUInteger)max;
|
|
|
|
/** Specifies the timeout allowed for a thread to close down when the pool
|
|
* is deallocated or has its size decreased. Any operations in progress in
|
|
* the thread need to close down within this period.
|
|
*/
|
|
- (void) setTimeout: (NSTimeInterval)t;
|
|
|
|
/** Returns the current timeout set for the pool.
|
|
*/
|
|
- (NSTimeInterval) timeout;
|
|
|
|
/** Releases a thread previously selected from the pool.
|
|
*/
|
|
- (void) unacquireThread: (NSThread*)aThread;
|
|
|
|
@end
|
|
|
|
#endif
|