OFTimer.h

/*
 * 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"

@class OFTimer;
@class OFDate;
@class OFCondition;

#ifdef OF_HAVE_BLOCKS
typedef void (^of_timer_block_t)(OFTimer*);
#endif

@interface OFTimer: OFObject <OFComparing>
{
    OFDate *fireDate;
    double interval;
    id target, object1, object2;
    SEL selector;
    uint8_t arguments;
    BOOL repeats;
#ifdef OF_HAVE_BLOCKS
    of_timer_block_t block;
#endif
    BOOL isValid, done;
    OFCondition *condition;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, retain) OFDate *fireDate;
#endif

+ (instancetype)scheduledTimerWithTimeInterval: (double)interval
                    target: (id)target
                      selector: (SEL)selector
                       repeats: (BOOL)repeats;

+ (instancetype)scheduledTimerWithTimeInterval: (double)interval
                    target: (id)target
                      selector: (SEL)selector
                    object: (id)object
                       repeats: (BOOL)repeats;

+ (instancetype)scheduledTimerWithTimeInterval: (double)interval
                    target: (id)target
                      selector: (SEL)selector
                    object: (id)object1
                    object: (id)object2
                       repeats: (BOOL)repeats;

#ifdef OF_HAVE_BLOCKS

+ (instancetype)scheduledTimerWithTimeInterval: (double)interval
                       repeats: (BOOL)repeats
                     block: (of_timer_block_t)block;
#endif

+ (instancetype)timerWithTimeInterval: (double)interval
                   target: (id)target
                 selector: (SEL)selector
                  repeats: (BOOL)repeats;

+ (instancetype)timerWithTimeInterval: (double)interval
                   target: (id)target
                 selector: (SEL)selector
                   object: (id)object
                  repeats: (BOOL)repeats;

+ (instancetype)timerWithTimeInterval: (double)interval
                   target: (id)target
                 selector: (SEL)selector
                   object: (id)object1
                   object: (id)object2
                  repeats: (BOOL)repeats;

#ifdef OF_HAVE_BLOCKS

+ (instancetype)timerWithTimeInterval: (double)interval
                  repeats: (BOOL)repeats
                block: (of_timer_block_t)block;
#endif

- initWithFireDate: (OFDate*)fireDate
      interval: (double)interval
        target: (id)target
      selector: (SEL)selector
       repeats: (BOOL)repeats;

- initWithFireDate: (OFDate*)fireDate
      interval: (double)interval
        target: (id)target
      selector: (SEL)selector
        object: (id)object
       repeats: (BOOL)repeats;

- initWithFireDate: (OFDate*)fireDate
      interval: (double)interval
        target: (id)target
      selector: (SEL)selector
        object: (id)object1
        object: (id)object2
       repeats: (BOOL)repeats;

#ifdef OF_HAVE_BLOCKS

- initWithFireDate: (OFDate*)fireDate
      interval: (double)interval
       repeats: (BOOL)repeats
         block: (of_timer_block_t)block;
#endif

- (void)fire;

- (OFDate*)fireDate;

- (void)invalidate;

- (BOOL)isValid;

- (double)timeInterval;

- (void)waitUntilDone;
@end