OFRunLoop.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 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/>.
 */
 
#import "OFObject.h"
#import "OFString.h"
 
#ifdef OF_AMIGAOS
# include <exec/types.h>
#endif
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFSortedList OF_GENERIC(ObjectType);
#ifdef OF_HAVE_THREADS
@class OFMutex;
@class OFCondition;
#endif
#ifdef OF_HAVE_SOCKETS
@class OFKernelEventObserver;
#endif
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFTimer;
@class OFDate;
 
typedef OFConstantString *OFRunLoopMode;
 
#ifdef __cplusplus
extern "C" {
#endif
extern const OFRunLoopMode OFDefaultRunLoopMode;
#ifdef __cplusplus
}
#endif
 
OF_SUBCLASSING_RESTRICTED
@interface OFRunLoop: OFObject
{
    OFMutableDictionary *_states;
#ifdef OF_HAVE_THREADS
    OFMutex *_statesMutex;
#endif
    OFRunLoopMode _Nullable _currentMode;
    volatile bool _stop;
}
 
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nullable, nonatomic) OFRunLoop *mainRunLoop;
@property (class, readonly, nullable, nonatomic) OFRunLoop *currentRunLoop;
#endif
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFRunLoopMode currentMode;
 
+ (nullable OFRunLoop *)mainRunLoop;
 
+ (nullable OFRunLoop *)currentRunLoop;
 
- (void)addTimer: (OFTimer *)timer;
 
- (void)addTimer: (OFTimer *)timer forMode: (OFRunLoopMode)mode;
 
#if defined(OF_AMIGAOS) || defined(DOXYGEN)
- (void)addExecSignal: (ULONG)signal target: (id)target selector: (SEL)selector;
 
- (void)addExecSignal: (ULONG)signal
          forMode: (OFRunLoopMode)mode
           target: (id)target
         selector: (SEL)selector;
 
- (void)removeExecSignal: (ULONG)signal
          target: (id)target
        selector: (SEL)selector;
 
- (void)removeExecSignal: (ULONG)signal
         forMode: (OFRunLoopMode)mode
          target: (id)target
        selector: (SEL)selector;
#endif
 
- (void)run;
 
- (void)runUntilDate: (nullable OFDate *)deadline;
 
- (void)runMode: (OFRunLoopMode)mode beforeDate: (nullable OFDate *)deadline;
 
- (void)stop;
@end
 
OF_ASSUME_NONNULL_END