Artifact 9008bb5cf4f424566a8e85681e608d1b911418d5aca82ee03ba5add5a1d63b3f:
- File
src/OFThread.h
— part of check-in
[0639a351db]
at
2012-11-10 00:14:59
on branch trunk
— Remove "object" from OFThread.
Blocks don't allow passing it anymore and without blocks, subclassing is
necessary anyway so that an ivar with the correct type can be added
(instead of id) if required. (user: js, size: 4881) [annotate] [blame] [check-ins using]
/* * Copyright (c) 2008, 2009, 2010, 2011, 2012 * Jonathan Schleifer <js@webkeks.org> * * All rights reserved. * * This file is part of ObjFW. It may be distributed under the terms of the * Q Public License 1.0, which can be found in the file LICENSE.QPL included in * the packaging of this file. * * Alternatively, it may be distributed under the terms of the GNU General * Public License, either version 2 or 3, which can be found in the file * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this * file. */ #import "OFObject.h" #import "OFTLSKey.h" #import "threading.h" /* Haiku used to define this for some unknown reason which causes trouble */ #ifdef protected # undef protected #endif @class OFDate; @class OFSortedList; @class OFRunLoop; #ifdef OF_HAVE_BLOCKS typedef id (^of_thread_block_t)(void); #endif /*! * @brief A class which provides portable threads. * * To use it, you should create a new class derived from it and reimplement * main. * * @warning Even though the OFCopying protocol is implemented, it does * <i>not</i> return an independent copy of the thread, but instead * retains it. This is so that the thread can be used as a key for a * dictionary, so context can be associated with a thread. */ @interface OFThread: OFObject <OFCopying> { #ifdef OF_THREAD_M @public #else @private #endif of_thread_t thread; enum { OF_THREAD_NOT_RUNNING, OF_THREAD_RUNNING, OF_THREAD_WAITING_FOR_JOIN } running; #ifdef OF_HAVE_BLOCKS of_thread_block_t block; #endif id returnValue; OFRunLoop *runLoop; } #if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS) @property (copy) of_thread_block_t block; #endif /*! * @brief Creates a new thread. * * @return A new, autoreleased thread */ + (instancetype)thread; #ifdef OF_HAVE_BLOCKS /*! * @brief Creates a new thread with the specified block. * * @param block A block which is executed by the thread * @return A new, autoreleased thread */ + (instancetype)threadWithBlock: (of_thread_block_t)block; #endif /*! * @brief Sets the Thread Local Storage for the specified key. * * The specified object is first retained and then the object stored before is * released. You can specify nil as object if you want the old object to be * released and don't want any new object for the TLS key. * * @param key The Thread Local Storage key * @param object The object the Thread Local Storage key will be set to */ + (void)setObject: (id)object forTLSKey: (OFTLSKey*)key; /*! * @brief Returns the object for the specified Thread Local Storage key. * * The returned object is <i>not</i> retained and autoreleased for performance * reasons! * * @param key The Thread Local Storage key */ + (id)objectForTLSKey: (OFTLSKey*)key; /*! * @brief Returns the current thread. * * @return The current thread */ + (OFThread*)currentThread; /*! * @brief Returns the main thread. * * @return The main thread */ + (OFThread*)mainThread; /*! * @brief Suspends execution of the current thread for the specified time * interval. * * @param seconds The number of seconds to sleep */ + (void)sleepForTimeInterval: (double)seconds; /*! * @brief Suspends execution of the current thread until the specified date. * * @param date The date to wait for */ + (void)sleepUntilDate: (OFDate*)date; /*! * @brief Yields a processor voluntarily and moves the thread at the end of the * queue for its priority. */ + (void)yield; /*! * @brief Terminates the current thread, letting it return nil. */ + (void)terminate; /*! * @brief Terminates the current thread, letting it return the specified object. * * @param object The object which the terminated thread will return */ + (void)terminateWithObject: (id)object; + (void)OF_createMainThread; #ifdef OF_HAVE_BLOCKS /*! * @brief Initializes an already allocated thread with the specified block. * * @param block A block which is executed by the thread * @return An initialized OFThread. */ - initWithBlock: (of_thread_block_t)block; #endif /*! * @brief The main routine of the thread. You need to reimplement this! * * It can access the object passed to the threadWithObject or initWithObject * method using the instance variable named object. * * @return The object the join method should return when called for this thread */ - (id)main; /*! * @brief This routine is exectued when the thread's main method has finished * executing or terminate has been called. * * @note Be sure to call [super handleTermination]! */ - (void)handleTermination; /*! * @brief Starts the thread. */ - (void)start; /*! * @brief Joins a thread. * * @return The object returned by the main method of the thread. */ - (id)join; /*! * @brief Returns the run loop for the thread. * * @return The run loop for the thread */ - (OFRunLoop*)runLoop; @end