OFThread.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2025 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#include <setjmp.h>
 
#import "OFObject.h"
#ifdef OF_HAVE_THREADS
# import "OFPlainThread.h"
#endif
 
OF_ASSUME_NONNULL_BEGIN

 
@class OFDate;
#ifdef OF_HAVE_SOCKETS
@class OFDNSResolver;
#endif
@class OFRunLoop;
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
 
#if defined(OF_HAVE_THREADS) && defined(OF_HAVE_BLOCKS)
typedef id _Nullable (^OFThreadBlock)(void);
#endif

@interface OFThread: OFObject
#ifdef OF_HAVE_THREADS
    <OFCopying>
{
@private
    OFPlainThread _thread;
    OFPlainThreadAttributes _attr;
    enum OFThreadState {
        OFThreadStateNotRunning,
        OFThreadStateRunning,
        OFThreadStateWaitingForJoin
    } _running;
# ifndef OF_OBJFW_RUNTIME
    void *_pool;
# endif
# ifdef OF_HAVE_BLOCKS
    OFThreadBlock _Nullable _block;
# endif
    jmp_buf _exitEnv;
    id _returnValue;
    bool _supportsSockets;
    OFRunLoop *_Nullable _runLoop;
    OFMutableDictionary *_threadDictionary;
    OFString *_Nullable _name;
# ifdef OF_HAVE_SOCKETS
    OFDNSResolver *_DNSResolver;
# endif
    OF_RESERVE_IVARS(OFThread, 4)
}
#endif
 
#ifdef OF_HAVE_CLASS_PROPERTIES
# ifdef OF_HAVE_THREADS
@property (class, readonly, nullable, nonatomic) OFThread *currentThread;
@property (class, readonly, nullable, nonatomic) OFThread *mainThread;
@property (class, readonly, nonatomic) bool isMainThread;
@property (class, readonly, nullable, nonatomic)
    OFMutableDictionary *threadDictionary;
@property (class, nullable, copy, nonatomic) OFString *name;
# endif
# ifdef OF_HAVE_SOCKETS
@property (class, readonly, nonatomic) OFDNSResolver *DNSResolver;
# endif
#endif
 
#ifdef OF_HAVE_THREADS
@property OF_NULLABLE_PROPERTY (copy) OFString *name;
 
# ifdef OF_HAVE_BLOCKS
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFThreadBlock block;
# endif

@property (readonly, nonatomic) OFRunLoop *runLoop;

@property (nonatomic) float priority;

@property (nonatomic) size_t stackSize;

@property (nonatomic) bool supportsSockets;

+ (instancetype)thread;
 
# ifdef OF_HAVE_BLOCKS
+ (instancetype)threadWithBlock: (OFThreadBlock)block;
# endif

+ (nullable OFThread *)currentThread;

+ (nullable OFThread *)mainThread;

+ (bool)isMainThread;

+ (nullable OFMutableDictionary *)threadDictionary;
#endif
 
#ifdef OF_HAVE_SOCKETS
+ (nullable OFDNSResolver *)DNSResolver;
#endif

+ (void)sleepForTimeInterval: (OFTimeInterval)timeInterval;

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

+ (void)yield;
 
#if defined(OF_WII) || defined(OF_NINTENDO_DS) || defined(OF_NINTENDO_3DS) || \
    defined(DOXYGEN)
+ (void)waitForVerticalBlank;
#endif
 
#ifdef OF_HAVE_THREADS
+ (void)terminate OF_NO_RETURN;

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

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

+ (nullable OFString *)name;
 
# ifdef OF_HAVE_BLOCKS
- (instancetype)initWithBlock: (OFThreadBlock)block;
# endif

- (nullable id)main;

- (void)handleTermination OF_REQUIRES_SUPER;

- (void)start;

- (id)join;
#else
- (instancetype)init OF_UNAVAILABLE;
#endif
@end
 
OF_ASSUME_NONNULL_END