OFThread.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   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"

#ifdef OF_HAVE_THREADS
# import "threading.h"
#endif

OF_ASSUME_NONNULL_BEGIN

@class OFDate;
@class OFRunLoop;
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);

#if defined(OF_HAVE_THREADS) && defined(OF_HAVE_BLOCKS)

typedef id OF_NULLABLE (^of_thread_block_t)(void);
#endif

@interface OFThread: OFObject
#ifdef OF_HAVE_THREADS
    <OFCopying>
{
# ifdef OF_THREAD_M
@public
# else
@private
# endif
    of_thread_t _thread;
    of_thread_attr_t _attr;
    enum {
        OF_THREAD_NOT_RUNNING,
        OF_THREAD_RUNNING,
        OF_THREAD_WAITING_FOR_JOIN
    } _running;
    void *_pool;
# ifdef OF_HAVE_BLOCKS
    of_thread_block_t _threadBlock;
# endif
    id _returnValue;
    OFRunLoop *_runLoop;
    OFMutableDictionary *_threadDictionary;
@private
    OFString *_name;
}

# ifdef OF_HAVE_PROPERTIES
#  ifdef OF_HAVE_BLOCKS
@property (copy) of_thread_block_t threadBlock;
#  endif
@property (copy) OFString *name;
@property float priority;
@property size_t stackSize;
# endif

+ (instancetype)thread;

# ifdef OF_HAVE_BLOCKS

+ (instancetype)threadWithThreadBlock: (of_thread_block_t)threadBlock;
# endif

+ (OFThread*)currentThread;

+ (OFThread*)mainThread;

+ (OFMutableDictionary*)threadDictionary;
#endif

+ (void)sleepForTimeInterval: (of_time_interval_t)timeInterval;

+ (void)sleepUntilDate: (OFDate*)date;

+ (void)yield;

#ifdef OF_HAVE_THREADS

+ (void)terminate OF_NO_RETURN;

+ (void)terminateWithObject: (nullable id)object OF_NO_RETURN;

# ifdef OF_HAVE_BLOCKS

- initWithThreadBlock: (of_thread_block_t)threadBlock;
# endif

- (nullable id)main;

- (void)handleTermination OF_REQUIRES_SUPER;

- (void)start;

- (id)join;

- (OFRunLoop*)runLoop;

- (nullable OFString*)name;

- (void)setName: (nullable OFString*)name;

- (float)priority;

- (void)setPriority: (float)priority;

- (size_t)stackSize;

- (void)setStackSize: (size_t)stackSize;
#endif
@end

OF_ASSUME_NONNULL_END