OFDatagramSocket.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 OFDatagramSocket;
 
#ifdef OF_HAVE_BLOCKS
typedef bool (^OFDatagramSocketAsyncReceiveBlock)(size_t length,
    const OFSocketAddress *_Nonnull sender, id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use OFDatagramSocketPacketReceivedHandler instead");
 
typedef bool (^OFDatagramSocketPacketReceivedHandler)(OFDatagramSocket *socket,
    void *buffer, size_t length, const OFSocketAddress *_Nonnull sender,
    id _Nullable exception);
 
typedef OFData *_Nullable (^OFDatagramSocketAsyncSendDataBlock)(
    id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use OFDatagramSocketDataSentHandler instead");
 
typedef OFData *_Nullable (^OFDatagramSocketDataSentHandler)(
    OFDatagramSocket *socket, OFData *data,
    const OFSocketAddress *_Nonnull receiver, id _Nullable exception);
#endif
 
@protocol OFDatagramSocketDelegate <OFObject>
@optional
-     (bool)socket: (OFDatagramSocket *)socket
  didReceiveIntoBuffer: (void *)buffer
        length: (size_t)length
        sender: (const OFSocketAddress *_Nonnull)sender
         exception: (nullable id)exception;
 
- (nullable OFData *)socket: (OFDatagramSocket *)socket
        didSendData: (OFData *)data
           receiver: (const OFSocketAddress *_Nonnull)receiver
          exception: (nullable id)exception;
@end
 
@interface OFDatagramSocket: OFObject <OFCopying, OFReadyForReadingObserving,
    OFReadyForWritingObserving>
{
    OFSocketHandle _socket;
#ifdef OF_AMIGAOS
    LONG _socketID;
    int _family;    /* unused, reserved for ABI stability */
#endif
    bool _canBlock;
#ifdef OF_WII
    bool _canSendToBroadcastAddresses;
#endif
    id <OFDatagramSocketDelegate> _Nullable _delegate;
    OF_RESERVE_IVARS(OFDatagramSocket, 4)
}
 
@property (nonatomic) bool canBlock;
 
@property (nonatomic) bool canSendToBroadcastAddresses;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFDatagramSocketDelegate> delegate;
 
+ (instancetype)socket;
 
- (size_t)receiveIntoBuffer: (void *)buffer
             length: (size_t)length
             sender: (nullable OFSocketAddress *)sender;
 
- (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: (OFDatagramSocketAsyncReceiveBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncReceiveIntoBuffer:length:handler:] instead");
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
               handler: (OFDatagramSocketPacketReceivedHandler)handler;
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
           runLoopMode: (OFRunLoopMode)runLoopMode
             block: (OFDatagramSocketAsyncReceiveBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncReceiveIntoBuffer:length:runLoopMode:handler:] instead");
 
- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
           runLoopMode: (OFRunLoopMode)runLoopMode
               handler: (OFDatagramSocketPacketReceivedHandler)handler;
#endif
 
- (void)sendBuffer: (const void *)buffer
        length: (size_t)length
      receiver: (const OFSocketAddress *)receiver;
 
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver;
 
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver
      runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver
        block: (OFDatagramSocketAsyncSendDataBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncSendData:receiver:handler:] instead");
 
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver
          handler: (OFDatagramSocketDataSentHandler)handler;
 
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver
      runLoopMode: (OFRunLoopMode)runLoopMode
        block: (OFDatagramSocketAsyncSendDataBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncSendData:receiver:runLoopMode:handler:] instead");
 
- (void)asyncSendData: (OFData *)data
         receiver: (const OFSocketAddress *)receiver
      runLoopMode: (OFRunLoopMode)runLoopMode
          handler: (OFDatagramSocketDataSentHandler)handler;
#endif
 
- (void)releaseSocketFromCurrentThread;
 
- (void)obtainSocketForCurrentThread;
 
- (void)cancelAsyncRequests;
 
- (void)close;
@end
 
OF_ASSUME_NONNULL_END