OFKernelEventObserver.h

/*
 * 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/>.
 */
 
#import "OFObject.h"
#ifdef OF_HAVE_SOCKETS
# import "OFSocket.h"
#endif
#import "OFRunLoop.h"
 
#ifdef OF_AMIGAOS
# include <exec/types.h>
# include <exec/tasks.h>
#endif
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFDate;
@class OFMutableData;

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

- (void)objectIsReadyForWriting: (id)object;
 
#if defined(OF_AMIGAOS) || defined(DOXYGEN)
- (void)execSignalWasReceived: (ULONG)signalMask;
#endif
@end

@protocol OFReadyForReadingObserving <OFObject>
@property (readonly, nonatomic) int fileDescriptorForReading;
@end

@protocol OFReadyForWritingObserving <OFObject>
@property (readonly, nonatomic) int fileDescriptorForWriting;
@end
 
#ifdef OF_HAVE_SOCKETS
@interface OFKernelEventObserver: OFObject
{
    OFMutableArray OF_GENERIC(id <OFReadyForReadingObserving>)
        *_readObjects;
    OFMutableArray OF_GENERIC(id <OFReadyForWritingObserving>)
        *_writeObjects;
    id <OFKernelEventObserverDelegate> _Nullable _delegate;
# if defined(OF_AMIGAOS)
    struct Task *_waitingTask;
    ULONG _cancelSignal;
# elif defined(OF_HAVE_PIPE)
    int _cancelFD[2];
# else
    OFSocketHandle _cancelFD[2];
    struct sockaddr_in _cancelAddr;
# endif
# ifdef OF_AMIGAOS
    ULONG _execSignalMask;
# endif
    OF_RESERVE_IVARS(OFKernelEventObserver, 4)
}

@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFKernelEventObserverDelegate> delegate;
 
# if defined(OF_AMIGAOS) || defined(DOXYGEN)
@property (nonatomic) ULONG execSignalMask;
# endif
 
# ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) bool handlesForeignEvents;
# endif

+ (instancetype)observer;

+ (bool)handlesForeignEvents;

- (instancetype)init;

- (instancetype)initWithRunLoopMode: (nullable OFRunLoopMode)runLoopMode;

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

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

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

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

- (void)observe;

- (void)observeForTimeInterval: (OFTimeInterval)timeInterval;

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

- (void)cancel;

- (bool)processReadBuffers;
@end
#endif
 
OF_ASSUME_NONNULL_END