OFStreamSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 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 "OFStream.h"
#import "OFSocket.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFStreamSocket;
 
#ifdef OF_HAVE_BLOCKS
typedef bool (^OFStreamSocketAsyncAcceptBlock)(OFStreamSocket *acceptedSocket,
    id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2, "Use OFStreamSocketAcceptedHandler instead");
 
typedef bool (^OFStreamSocketAcceptedHandler)(OFStreamSocket *socket,
    OFStreamSocket *acceptedSocket, id _Nullable exception);
#endif
 
@protocol OFStreamSocketDelegate <OFStreamDelegate>
@optional
-    (bool)socket: (OFStreamSocket *)socket
  didAcceptSocket: (OFStreamSocket *)acceptedSocket
    exception: (nullable id)exception;
@end
 
@interface OFStreamSocket: OFStream <OFReadyForReadingObserving,
    OFReadyForWritingObserving>
{
    OFSocketHandle _socket;
#ifdef OF_AMIGAOS
    LONG _socketID;
    int _family;    /* unused, reserved for ABI stability */
#endif
    bool _atEndOfStream, _listening;
    OFSocketAddress _remoteAddress;
    OF_RESERVE_IVARS(OFStreamSocket, 4)
}
 
@property (readonly, nonatomic, getter=isListening) bool listening;
 
@property (readonly, nonatomic) const OFSocketAddress *remoteAddress;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFStreamSocketDelegate> delegate;
 
+ (instancetype)socket;
 
- (void)listenWithBacklog: (int)backlog;
 
- (void)listen;
 
- (instancetype)accept;
 
- (void)asyncAccept;
 
- (void)asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncAcceptWithBlock: (OFStreamSocketAsyncAcceptBlock)block
    OF_DEPRECATED(ObjFW, 1, 2, "Use -[asyncAcceptWithHandler:] instead");
 
- (void)asyncAcceptWithHandler: (OFStreamSocketAcceptedHandler)handler;
 
- (void)asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode
                 block: (OFStreamSocketAsyncAcceptBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncAcceptWithRunLoopMode:handler:] instead");
 
- (void)asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode
               handler: (OFStreamSocketAcceptedHandler)handler;
#endif
 
- (void)releaseSocketFromCurrentThread;
 
- (void)obtainSocketForCurrentThread;
@end
 
OF_ASSUME_NONNULL_END