OFTimer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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"

OF_ASSUME_NONNULL_BEGIN

@class OFTimer;
@class OFDate;
@class OFRunLoop;
#ifdef OF_HAVE_THREADS
@class OFCondition;
#endif

#ifdef OF_HAVE_BLOCKS

typedef void (^of_timer_block_t)(OFTimer *timer);
#endif

@interface OFTimer: OFObject <OFComparing>
{
    OFDate *_fireDate;
    of_time_interval_t _interval;
    id _target;
    id _Nullable _object1, _object2;
    SEL _selector;
    uint8_t _arguments;
    bool _repeats;
#ifdef OF_HAVE_BLOCKS
    of_timer_block_t _block;
#endif
    bool _valid;
#ifdef OF_HAVE_THREADS
    OFCondition *_condition;
    bool _done;
#endif
    OFRunLoop *_Nullable _inRunLoop;
}

@property (readonly, nonatomic) of_time_interval_t timeInterval;

@property (readonly, nonatomic, getter=isRepeating) bool repeating;

@property (readonly, nonatomic, getter=isValid) bool valid;

+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
                    target: (id)target
                      selector: (SEL)selector
                       repeats: (bool)repeats;

+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
                    target: (id)target
                      selector: (SEL)selector
                    object: (nullable id)object
                       repeats: (bool)repeats;

+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
                    target: (id)target
                      selector: (SEL)selector
                    object: (nullable id)object1
                    object: (nullable id)object2
                       repeats: (bool)repeats;

#ifdef OF_HAVE_BLOCKS

+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
                       repeats: (bool)repeats
                     block: (of_timer_block_t)block;
#endif

+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
                   target: (id)target
                 selector: (SEL)selector
                  repeats: (bool)repeats;

+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
                   target: (id)target
                 selector: (SEL)selector
                   object: (nullable id)object
                  repeats: (bool)repeats;

+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
                   target: (id)target
                 selector: (SEL)selector
                   object: (nullable id)object1
                   object: (nullable id)object2
                  repeats: (bool)repeats;

#ifdef OF_HAVE_BLOCKS

+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
                  repeats: (bool)repeats
                block: (of_timer_block_t)block;
#endif

- init OF_UNAVAILABLE;

- initWithFireDate: (OFDate *)fireDate
      interval: (of_time_interval_t)interval
        target: (id)target
      selector: (SEL)selector
       repeats: (bool)repeats;

- initWithFireDate: (OFDate *)fireDate
      interval: (of_time_interval_t)interval
        target: (id)target
      selector: (SEL)selector
        object: (nullable id)object
       repeats: (bool)repeats;

- initWithFireDate: (OFDate *)fireDate
      interval: (of_time_interval_t)interval
        target: (id)target
      selector: (SEL)selector
        object: (nullable id)object1
        object: (nullable id)object2
       repeats: (bool)repeats;

#ifdef OF_HAVE_BLOCKS

- initWithFireDate: (OFDate *)fireDate
      interval: (of_time_interval_t)interval
       repeats: (bool)repeats
         block: (of_timer_block_t)block;
#endif

- (void)fire;

- (OFDate *)fireDate;

- (void)setFireDate: (OFDate *)fireDate;

- (void)invalidate;

#ifdef OF_HAVE_THREADS

- (void)waitUntilDone;
#endif
@end

OF_ASSUME_NONNULL_END