OFSequencedPacketSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 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"
#import "OFKernelEventObserver.h"
#import "OFRunLoop.h"
#import "OFSocket.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFData;
@class OFSequencedPacketSocket;
 
#ifdef OF_HAVE_BLOCKS
typedef bool (^OFSequencedPacketSocketAsyncReceiveBlock)(size_t length,
    id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use OFSequencedPacketSocketPacketReceivedHandler instead");
 
typedef bool (^OFSequencedPacketSocketPacketReceivedHandler)(
    OFSequencedPacketSocket *socket, void *buffer, size_t length,
    id _Nullable exception);
 
typedef OFData *_Nullable (^OFSequencedPacketSocketAsyncSendDataBlock)(
    id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use OFSequencedPacketSocketDataSentHandler instead");
 
typedef OFData *_Nullable (^OFSequencedPacketSocketDataSentHandler)(
    OFSequencedPacketSocket *socket, OFData *data, id _Nullable exception);
 
typedef bool (^OFSequencedPacketSocketAsyncAcceptBlock)(
    OFSequencedPacketSocket *acceptedSocket, id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use OFSequencedPacketSocketAcceptedHandler instead");
 
typedef bool (^OFSequencedPacketSocketAcceptedHandler)(
    OFSequencedPacketSocket *socket, OFSequencedPacketSocket *acceptedSocket,
    id _Nullable exception);
#endif
 
@protocol OFSequencedPacketSocketDelegate <OFObject>
@optional
-     (bool)socket: (OFSequencedPacketSocket *)socket
  didReceiveIntoBuffer: (void *)buffer
        length: (size_t)length
         exception: (nullable id)exception;
 
- (nullable OFData *)socket: (OFSequencedPacketSocket *)socket
        didSendData: (OFData *)data
          exception: (nullable id)exception;
 
-    (bool)socket: (OFSequencedPacketSocket *)socket
  didAcceptSocket: (OFSequencedPacketSocket *)acceptedSocket
    exception: (nullable id)exception;
@end
 
@interface OFSequencedPacketSocket: OFObject <OFCopying,
    OFReadyForReadingObserving, OFReadyForWritingObserving>
{
    OFSocketHandle _socket;
#ifdef OF_AMIGAOS
    LONG _socketID; /* unused, reserved for ABI stability */
    int _family;    /* unused, reserved for ABI stability */
#endif
    bool _canBlock, _listening;
    OFSocketAddress _remoteAddress;
    id _Nullable _delegate;
    OF_RESERVE_IVARS(OFSequencedPacketSocket, 4)
}
 
@property (nonatomic) bool canBlock;
 
@property (readonly, nonatomic, getter=isListening) bool listening;
 
@property (readonly, nonatomic) const OFSocketAddress *remoteAddress;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFSequencedPacketSocketDelegate> delegate;
 
+ (instancetype)socket;
 
- (size_t)receiveIntoBuffer: (void *)buffer length: (size_t)length;
 
- (void)asyncReceiveIntoBuffer: (void *)buffer length: (size_t)length;
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
           runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
             block: (OFSequencedPacketSocketAsyncReceiveBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncReceiveIntoBuffer:length:handler:] instead");
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
               handler: (OFSequencedPacketSocketPacketReceivedHandler)
                    handler;
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
           runLoopMode: (OFRunLoopMode)runLoopMode
             block: (OFSequencedPacketSocketAsyncReceiveBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncReceiveIntoBuffer:length:runLoopMode:handler:] instead");
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
           runLoopMode: (OFRunLoopMode)runLoopMode
               handler: (OFSequencedPacketSocketPacketReceivedHandler)
                    handler;
#endif
 
- (void)sendBuffer: (const void *)buffer length: (size_t)length;
 
- (void)asyncSendData: (OFData *)data;
 
- (void)asyncSendData: (OFData *)data runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncSendData: (OFData *)data
        block: (OFSequencedPacketSocketAsyncSendDataBlock)block
    OF_DEPRECATED(ObjFW, 1, 2, "Use -[asyncSendData:handler:] instead");
 
- (void)asyncSendData: (OFData *)data
          handler: (OFSequencedPacketSocketDataSentHandler)handler;
 
- (void)asyncSendData: (OFData *)data
      runLoopMode: (OFRunLoopMode)runLoopMode
        block: (OFSequencedPacketSocketAsyncSendDataBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncSendData:runLoopMode:handler:] instead");
 
- (void)asyncSendData: (OFData *)data
      runLoopMode: (OFRunLoopMode)runLoopMode
          handler: (OFSequencedPacketSocketDataSentHandler)handler;
#endif
 
- (void)listenWithBacklog: (int)backlog;
 
- (void)listen;
 
- (instancetype)accept;
 
- (void)asyncAccept;
 
- (void)asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncAcceptWithBlock: (OFSequencedPacketSocketAsyncAcceptBlock)block
    OF_DEPRECATED(ObjFW, 1, 2, "Use -[asyncAcceptWithHandler:] instead");
 
- (void)asyncAcceptWithHandler: (OFSequencedPacketSocketAcceptedHandler)handler;
 
- (void)
    asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode
             block: (OFSequencedPacketSocketAsyncAcceptBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncAcceptWithRunLoopMode:handler:] instead");
 
- (void)
    asyncAcceptWithRunLoopMode: (OFRunLoopMode)runLoopMode
               handler: (OFSequencedPacketSocketAcceptedHandler)handler;
#endif
 
- (void)cancelAsyncRequests;
 
- (void)releaseSocketFromCurrentThread;
 
- (void)obtainSocketForCurrentThread;
 
- (void)close;
@end
 
OF_ASSUME_NONNULL_END