OFKernelEventObserver.h

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

#import "socket.h"

OF_ASSUME_NONNULL_BEGIN

@class OFMutableArray OF_GENERIC(ObjectType);
@class OFDate;
#ifdef OF_HAVE_THREADS
@class OFMutex;
#endif
@class OFMutableData;

@protocol OFKernelEventObserverDelegate <OFObject>
@optional
- (void)objectIsReadyForReading: (id)object;

- (void)objectIsReadyForWriting: (id)object;
@end

@protocol OFReadyForReadingObserving <OFObject>
- (int)fileDescriptorForReading;
@end

@protocol OFReadyForWritingObserving <OFObject>
- (int)fileDescriptorForWriting;
@end

@interface OFKernelEventObserver: OFObject
{
    OFMutableArray OF_GENERIC(id <OFReadyForReadingObserving>)
        *_readObjects;
    OFMutableArray OF_GENERIC(id <OFReadyForWritingObserving>)
        *_writeObjects;
    id <OFKernelEventObserverDelegate> _Nullable _delegate;
#ifdef OF_HAVE_PIPE
    int _cancelFD[2];
#else
    of_socket_t _cancelFD[2];
    struct sockaddr_in _cancelAddr;
#endif
#ifdef OF_HAVE_THREADS
    OFMutex *_mutex;
#endif
    OFMutableData *_queueActions;
    OFMutableArray *_queueObjects;
}

@property OF_NULLABLE_PROPERTY (nonatomic, assign)
    id <OFKernelEventObserverDelegate> delegate;

+ (instancetype)observer;

- (void)addObjectForReading: (id <OFReadyForReadingObserving>)object;

- (void)addObjectForWriting: (id <OFReadyForWritingObserving>)object;

- (void)removeObjectForReading: (id <OFReadyForReadingObserving>)object;

- (void)removeObjectForWriting: (id <OFReadyForWritingObserving>)object;

- (void)observe;

- (void)observeForTimeInterval: (of_time_interval_t)timeInterval;

- (void)observeUntilDate: (OFDate *)date;

- (void)cancel;
@end

OF_ASSUME_NONNULL_END