Index: src/Makefile ================================================================== --- src/Makefile +++ src/Makefile @@ -144,10 +144,11 @@ OFHTTPCookieManager.m \ OFHTTPRequest.m \ OFHTTPResponse.m \ OFHTTPServer.m \ ${OFIPXSOCKET_M} \ + OFSequencedPacketSocket.m \ OFStreamSocket.m \ OFTCPSocket.m \ OFUDPSocket.m \ socket.m SRCS_THREADS = OFCondition.m \ Index: src/OFDatagramSocket.h ================================================================== --- src/OFDatagramSocket.h +++ src/OFDatagramSocket.h @@ -129,11 +129,11 @@ /*! * @brief The delegate for asynchronous operations on the socket. * * @note The delegate is retained for as long as asynchronous operations are - * still outstanding. + * still ongoing. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFDatagramSocket.m ================================================================== --- src/OFDatagramSocket.m +++ src/OFDatagramSocket.m @@ -15,13 +15,11 @@ * file. */ #include "config.h" -#include #include -#include #ifdef HAVE_FCNTL_H # include #endif @@ -29,11 +27,10 @@ #import "OFData.h" #import "OFRunLoop+Private.h" #import "OFRunLoop.h" #import "OFInitializationFailedException.h" -#import "OFInvalidFormatException.h" #import "OFNotOpenException.h" #import "OFOutOfRangeException.h" #import "OFReadFailedException.h" #import "OFSetOptionFailedException.h" #import "OFWriteFailedException.h" Index: src/OFIPXSocket.h ================================================================== --- src/OFIPXSocket.h +++ src/OFIPXSocket.h @@ -56,11 +56,11 @@ /*! * @brief The delegate for asynchronous operations on the socket. * * @note The delegate is retained for as long as asynchronous operations are - * still outstanding. + * still ongoing. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFRunLoop+Private.h ================================================================== --- src/OFRunLoop+Private.h +++ src/OFRunLoop+Private.h @@ -16,12 +16,13 @@ */ #import "OFRunLoop.h" #import "OFStream.h" #ifdef OF_HAVE_SOCKETS -# import "OFTCPSocket.h" # import "OFDatagramSocket.h" +# import "OFSequencedPacketSocket.h" +# import "OFTCPSocket.h" #endif OF_ASSUME_NONNULL_BEGIN #ifdef OF_HAVE_SOCKETS @@ -86,19 +87,14 @@ + (void)of_addAsyncConnectForTCPSocket: (OFTCPSocket *)socket mode: (of_run_loop_mode_t)mode delegate: (id ) delegate; # endif -+ (void)of_addAsyncAcceptForTCPSocket: (OFTCPSocket *)socket - mode: (of_run_loop_mode_t)mode -# ifdef OF_HAVE_BLOCKS - block: (nullable - of_tcp_socket_async_accept_block_t) - block -# endif - delegate: (nullable id ) - delegate; ++ (void)of_addAsyncAcceptForSocket: (id)socket + mode: (of_run_loop_mode_t)mode + block: (nullable id)block + delegate: (nullable id)delegate; + (void)of_addAsyncReceiveForDatagramSocket: (OFDatagramSocket *)socket buffer: (void *)buffer length: (size_t)length mode: (of_run_loop_mode_t)mode # ifdef OF_HAVE_BLOCKS @@ -111,13 +107,30 @@ mode: (of_run_loop_mode_t)mode # ifdef OF_HAVE_BLOCKS block: (nullable of_datagram_socket_async_send_data_block_t)block # endif delegate: (nullable id )delegate; ++ (void)of_addAsyncReceiveForSequencedPacketSocket: + (OFSequencedPacketSocket *)socket + buffer: (void *)buffer + length: (size_t)length + mode: (of_run_loop_mode_t)mode +# ifdef OF_HAVE_BLOCKS + block: (nullable of_sequenced_packet_socket_async_receive_block_t)block +# endif + delegate: (nullable id ) delegate; ++ (void)of_addAsyncSendForSequencedPacketSocket: + (OFSequencedPacketSocket *)socket + data: (OFData *)data + mode: (of_run_loop_mode_t)mode +# ifdef OF_HAVE_BLOCKS + block: (nullable of_sequenced_packet_socket_async_send_data_block_t)block +# endif + delegate: (nullable id )delegate; + (void)of_cancelAsyncRequestsForObject: (id)object mode: (of_run_loop_mode_t)mode; #endif - (void)of_removeTimer: (OFTimer *)timer forMode: (of_run_loop_mode_t)mode; @end OF_ASSUME_NONNULL_END Index: src/OFRunLoop.m ================================================================== --- src/OFRunLoop.m +++ src/OFRunLoop.m @@ -25,10 +25,12 @@ #import "OFArray.h" #import "OFData.h" #import "OFDictionary.h" #ifdef OF_HAVE_SOCKETS # import "OFKernelEventObserver.h" +# import "OFDatagramSocket.h" +# import "OFSequencedPacketSocket.h" # import "OFTCPSocket.h" # import "OFTCPSocket+Private.h" #endif #import "OFThread.h" #ifdef OF_HAVE_THREADS @@ -155,11 +157,11 @@ @interface OFRunLoopAcceptQueueItem: OFRunLoopQueueItem { @public # ifdef OF_HAVE_BLOCKS - of_tcp_socket_async_accept_block_t _block; + id _block; # endif } @end @interface OFRunLoopDatagramReceiveQueueItem: OFRunLoopQueueItem @@ -181,10 +183,31 @@ # endif OFData *_data; of_socket_address_t _receiver; } @end + +@interface OFRunLoopPacketReceiveQueueItem: OFRunLoopQueueItem +{ +@public +# ifdef OF_HAVE_BLOCKS + of_sequenced_packet_socket_async_receive_block_t _block; +# endif + void *_buffer; + size_t _length; +} +@end + +@interface OFRunLoopPacketSendQueueItem: OFRunLoopQueueItem +{ +@public +# ifdef OF_HAVE_BLOCKS + of_sequenced_packet_socket_async_send_data_block_t _block; +# endif + OFData *_data; +} +@end #endif @implementation OFRunLoopState - (instancetype)init { @@ -733,24 +756,32 @@ # endif @implementation OFRunLoopAcceptQueueItem - (bool)handleObject: (id)object { - OFTCPSocket *acceptedSocket; - id exception = nil; + id acceptedSocket, exception = nil; @try { acceptedSocket = [object accept]; } @catch (id e) { acceptedSocket = nil; exception = e; } # ifdef OF_HAVE_BLOCKS - if (_block != NULL) - return _block(object, acceptedSocket, exception); - else { + if (_block != NULL) { + if ([object isKindOfClass: [OFTCPSocket class]]) + return ((of_tcp_socket_async_accept_block_t) + _block)(object, acceptedSocket, exception); + else if ([object isKindOfClass: + [OFSequencedPacketSocket class]]) + return + ((of_sequenced_packet_socket_async_accept_block_t) + _block)(object, acceptedSocket, exception); + else + OF_ENSURE(0); + } else { # endif if (![_delegate respondsToSelector: @selector(socket:didAcceptSocket:exception:)]) return false; @@ -852,10 +883,111 @@ newData = [_delegate socket: object didSendData: _data receiver: &_receiver exception: exception]; + if (newData == nil) + return false; + + oldData = _data; + _data = [newData copy]; + [oldData release]; + + return true; +# ifdef OF_HAVE_BLOCKS + } +# endif +} + +- (void)dealloc +{ + [_data release]; +# ifdef OF_HAVE_BLOCKS + [_block release]; +# endif + + [super dealloc]; +} +@end + +@implementation OFRunLoopPacketReceiveQueueItem +- (bool)handleObject: (id)object +{ + size_t length; + id exception = nil; + + @try { + length = [object receiveIntoBuffer: _buffer + length: _length]; + } @catch (id e) { + length = 0; + exception = e; + } + +# ifdef OF_HAVE_BLOCKS + if (_block != NULL) + return _block(object, _buffer, length, exception); + else { +# endif + if (![_delegate respondsToSelector: @selector( + socket:didReceiveIntoBuffer:length:exception:)]) + return false; + + return [_delegate socket: object + didReceiveIntoBuffer: _buffer + length: length + exception: exception]; +# ifdef OF_HAVE_BLOCKS + } +# endif +} + +# ifdef OF_HAVE_BLOCKS +- (void)dealloc +{ + [_block release]; + + [super dealloc]; +} +# endif +@end + +@implementation OFRunLoopPacketSendQueueItem +- (bool)handleObject: (id)object +{ + id exception = nil; + OFData *newData, *oldData; + + @try { + [object sendBuffer: _data.items + length: _data.count * _data.itemSize]; + } @catch (id e) { + exception = e; + } + +# ifdef OF_HAVE_BLOCKS + if (_block != NULL) { + newData = _block(object, _data, exception); + + if (newData == nil) + return false; + + oldData = _data; + _data = [newData copy]; + [oldData release]; + + return true; + } else { +# endif + if (![_delegate respondsToSelector: + @selector(socket:didSendData:exception:)]) + return false; + + newData = [_delegate socket: object + didSendData: _data + exception: exception]; + if (newData == nil) return false; oldData = _data; _data = [newData copy]; @@ -1063,18 +1195,16 @@ QUEUE_ITEM } # endif -+ (void)of_addAsyncAcceptForTCPSocket: (OFTCPSocket *)stream - mode: (of_run_loop_mode_t)mode -# ifdef OF_HAVE_BLOCKS - block: (of_tcp_socket_async_accept_block_t)block -# endif - delegate: (id )delegate -{ - NEW_READ(OFRunLoopAcceptQueueItem, stream, mode) ++ (void)of_addAsyncAcceptForSocket: (id)sock + mode: (of_run_loop_mode_t)mode + block: (id)block + delegate: (id)delegate +{ + NEW_READ(OFRunLoopAcceptQueueItem, sock, mode) queueItem->_delegate = [delegate retain]; # ifdef OF_HAVE_BLOCKS queueItem->_block = [block copy]; # endif @@ -1119,10 +1249,51 @@ queueItem->_block = [block copy]; # endif queueItem->_data = [data copy]; queueItem->_receiver = *receiver; + QUEUE_ITEM +} + ++ (void)of_addAsyncReceiveForSequencedPacketSocket: (OFSequencedPacketSocket *) + sock + buffer: (void *)buffer + length: (size_t)length + mode: (of_run_loop_mode_t)mode +# ifdef OF_HAVE_BLOCKS + block: (of_sequenced_packet_socket_async_receive_block_t)block +# endif + delegate: (id )delegate +{ + NEW_READ(OFRunLoopPacketReceiveQueueItem, sock, mode) + + queueItem->_delegate = [delegate retain]; +# ifdef OF_HAVE_BLOCKS + queueItem->_block = [block copy]; +# endif + queueItem->_buffer = buffer; + queueItem->_length = length; + + QUEUE_ITEM +} + ++ (void)of_addAsyncSendForSequencedPacketSocket: (OFSequencedPacketSocket *)sock + data: (OFData *)data + mode: (of_run_loop_mode_t)mode +# ifdef OF_HAVE_BLOCKS + block: (of_sequenced_packet_socket_async_send_data_block_t)block +# endif + delegate: (id )delegate +{ + NEW_WRITE(OFRunLoopPacketSendQueueItem, sock, mode) + + queueItem->_delegate = [delegate retain]; +# ifdef OF_HAVE_BLOCKS + queueItem->_block = [block copy]; +# endif + queueItem->_data = [data copy]; + QUEUE_ITEM } # undef NEW_READ # undef NEW_WRITE # undef QUEUE_ITEM ADDED src/OFSequencedPacketSocket.h Index: src/OFSequencedPacketSocket.h ================================================================== --- src/OFSequencedPacketSocket.h +++ src/OFSequencedPacketSocket.h @@ -0,0 +1,382 @@ +/* + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, + * 2018, 2019, 2020 + * Jonathan Schleifer + * + * 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 "OFKernelEventObserver.h" +#import "OFRunLoop.h" + +#import "socket.h" + +OF_ASSUME_NONNULL_BEGIN + +/*! @file */ + +@class OFData; +@class OFSequencedPacketSocket; + +#ifdef OF_HAVE_BLOCKS +/*! + * @brief A block which is called when a packet has been received. + * + * @param socket The sequenced packet socket which received a packet + * @param buffer The buffer the packet has been written to + * @param length The length of the packet + * @param exception An exception which occurred while receiving or `nil` on + * success + * @return A bool whether the same block should be used for the next receive + */ +typedef bool (^of_sequenced_packet_socket_async_receive_block_t)( + OFSequencedPacketSocket *_Nonnull socket, void *_Nonnull buffer, + size_t length, id _Nullable exception); + +/*! + * @brief A block which is called when a packet has been sent. + * + * @param socket The sequenced packet socket which sent a packet + * @param data The data which was sent + * @param exception An exception which occurred while reading or `nil` on + * success + * @return The data to repeat the send with or nil if it should not repeat + */ +typedef OFData *_Nullable (^of_sequenced_packet_socket_async_send_data_block_t)( + OFSequencedPacketSocket *_Nonnull socket, OFData *_Nonnull data, + id _Nullable exception); + +/*! + * @brief A block which is called when the socket accepted a connection. + * + * @param socket The socket which accepted the connection + * @param acceptedSocket The socket which has been accepted + * @param exception An exception which occurred while accepting the socket or + * `nil` on success + * @return A bool whether the same block should be used for the next incoming + * connection + */ +typedef bool (^of_sequenced_packet_socket_async_accept_block_t)( + OFSequencedPacketSocket *socket, OFSequencedPacketSocket *acceptedSocket, + id _Nullable exception); +#endif + +/*! + * @protocol OFSequencedPacketSocketDelegate OFSequencedPacketSocket.h \ + * ObjFW/OFSequencedPacketSocket.h + * + * @brief A delegate for OFSequencedPacketSocket. + */ +@protocol OFSequencedPacketSocketDelegate +@optional +/*! + * @brief This method is called when a packet has been received. + * + * @param socket The sequenced packet socket which received a packet + * @param buffer The buffer the packet has been written to + * @param length The length of the packet + * @param exception An exception that occurred while receiving, or nil on + * success + * @return A bool whether the same block should be used for the next receive + */ +- (bool)socket: (OFSequencedPacketSocket *)socket + didReceiveIntoBuffer: (void *)buffer + length: (size_t)length + exception: (nullable id)exception; + +/*! + * @brief This method is called when a packet has been sent. + * + * @param socket The sequenced packet socket which sent a packet + * @param data The data which was sent + * @param exception An exception that occurred while sending, or nil on success + * @return The data to repeat the send with or nil if it should not repeat + */ +- (nullable OFData *)socket: (OFSequencedPacketSocket *)socket + didSendData: (OFData *)data + exception: (nullable id)exception; + +/*! + * @brief A method which is called when a socket accepted a connection. + * + * @param socket The socket which accepted the connection + * @param acceptedSocket The socket which has been accepted + * @param exception An exception that occurred while accepting, or nil on + * success + * @return A bool whether to accept the next incoming connection + */ +- (bool)socket: (OFSequencedPacketSocket *)socket + didAcceptSocket: (OFSequencedPacketSocket *)acceptedSocket + exception: (nullable id)exception; +@end + +/*! + * @class OFSequencedPacketSocket OFSequencedPacketSocket.h \ + * ObjFW/OFSequencedPacketSocket.h + * + * @brief A base class for sequenced packet sockets. + * + * @warning Even though the OFCopying protocol is implemented, it does *not* + * return an independent copy of the socket, but instead retains it. + * This is so that the socket can be used as a key for a dictionary, + * so context can be associated with a socket. Using a socket in more + * than one thread at the same time is not thread-safe, even if copy + * was called to create one "instance" for every thread! + */ +@interface OFSequencedPacketSocket: OFObject +{ + of_socket_t _socket; + bool _blocking, _listening; + of_socket_address_t _remoteAddress; + id _Nullable _delegate; + OF_RESERVE_IVARS(4) +} + +/*! + * @brief Whether the socket is in blocking mode. + * + * By default, a socket is in blocking mode. + */ +@property (nonatomic, getter=isBlocking) bool blocking; + +/*! + * @brief Whether the socket is a listening socket. + */ +@property (readonly, nonatomic, getter=isListening) bool listening; + +/*! + * @brief The remote address. + * + * @note This only works for accepted sockets! + */ +@property (readonly, nonatomic) const of_socket_address_t *remoteAddress; + +/*! + * @brief The delegate for asynchronous operations on the socket. + * + * @note The delegate is retained for as long as asynchronous operations are + * still ongoing. + */ +@property OF_NULLABLE_PROPERTY (assign, nonatomic) + id delegate; + +/*! + * @brief Returns a new, autoreleased OFSequencedPacketSocket. + * + * @return A new, autoreleased OFSequencedPacketSocket + */ ++ (instancetype)socket; + +/*! + * @brief Receives a packet and stores it into the specified buffer. + * + * If the buffer is too small, the receive operation fails. + * + * @param buffer The buffer to write the packet to + * @param length The length of the buffer + * @return The length of the received packet + */ +- (size_t)receiveIntoBuffer: (void *)buffer + length: (size_t)length; + +/*! + * @brief Asynchronously receives a packet and stores it into the specified + * buffer. + * + * If the buffer is too small, the receive operation fails. + * + * @param buffer The buffer to write the packet to + * @param length The length of the buffer + */ +- (void)asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length; + +/*! + * @brief Asynchronously receives a packet and stores it into the specified + * buffer. + * + * If the buffer is too small, the receive operation fails. + * + * @param buffer The buffer to write the packet to + * @param length The length of the buffer + * @param runLoopMode The run loop mode in which to perform the async receive + */ +- (void)asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + runLoopMode: (of_run_loop_mode_t)runLoopMode; + +#ifdef OF_HAVE_BLOCKS +/*! + * @brief Asynchronously receives a packet and stores it into the specified + * buffer. + * + * If the buffer is too small, the receive operation fails. + * + * @param buffer The buffer to write the packet to + * @param length The length of the buffer + * @param block The block to call when the packet has been received. If the + * block returns true, it will be called again with the same + * buffer and maximum length when more packets have been received. + * If you want the next method in the queue to handle the packet + * received next, you need to return false from the method. + */ +- (void) + asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + block: (of_sequenced_packet_socket_async_receive_block_t) + block; + +/*! + * @brief Asynchronously receives a packet and stores it into the specified + * buffer. + * + * If the buffer is too small, the receive operation fails. + * + * @param buffer The buffer to write the packet to + * @param length The length of the buffer + * @param runLoopMode The run loop mode in which to perform the async receive + * @param block The block to call when the packet has been received. If the + * block returns true, it will be called again with the same + * buffer and maximum length when more packets have been received. + * If you want the next method in the queue to handle the packet + * received next, you need to return false from the method. + */ +- (void) + asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + runLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_receive_block_t) + block; +#endif + +/*! + * @brief Sends the specified packet. + * + * @param buffer The buffer to send as a packet + * @param length The length of the buffer + */ +- (void)sendBuffer: (const void *)buffer + length: (size_t)length; + +/*! + * @brief Asynchronously sends the specified packet. + * + * @param data The data to send as a packet + */ +- (void)asyncSendData: (OFData *)data; + +/*! + * @brief Asynchronously sends the specified packet. + * + * @param data The data to send as a packet + * @param runLoopMode The run loop mode in which to perform the async send + */ +- (void)asyncSendData: (OFData *)data + runLoopMode: (of_run_loop_mode_t)runLoopMode; + +#ifdef OF_HAVE_BLOCKS +/*! + * @brief Asynchronously sends the specified packet. + * + * @param data The data to send as a packet + * @param block The block to call when the packet has been sent. It should + * return the data for the next send with the same callback or nil + * if it should not repeat. + */ +- (void)asyncSendData: (OFData *)data + block: (of_sequenced_packet_socket_async_send_data_block_t) + block; + +/*! + * @brief Asynchronously sends the specified packet. + * + * @param data The data to send as a packet + * @param runLoopMode The run loop mode in which to perform the async send + * @param block The block to call when the packet has been sent. It should + * return the data for the next send with the same callback or nil + * if it should not repeat. + */ +- (void)asyncSendData: (OFData *)data + runLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_send_data_block_t) + block; +#endif + +/*! + * @brief Listen on the socket. + * + * @param backlog Maximum length for the queue of pending connections. + */ +- (void)listenWithBacklog: (int)backlog; + +/*! + * @brief Listen on the socket. + */ +- (void)listen; + +/*! + * @brief Accept an incoming connection. + * + * @return An autoreleased sequenced packet socket for the accepted connection. + */ +- (instancetype)accept; + +/*! + * @brief Asynchronously accept an incoming connection. + */ +- (void)asyncAccept; + +/*! + * @brief Asynchronously accept an incoming connection. + * + * @param runLoopMode The run loop mode in which to perform the async accept + */ +- (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode; + +#ifdef OF_HAVE_BLOCKS +/*! + * @brief Asynchronously accept an incoming connection. + * + * @param block The block to execute when a new connection has been accepted. + * Returns whether the next incoming connection should be accepted + * by the specified block as well. + */ +- (void)asyncAcceptWithBlock: + (of_sequenced_packet_socket_async_accept_block_t)block; + +/*! + * @brief Asynchronously accept an incoming connection. + * + * @param runLoopMode The run loop mode in which to perform the async accept + * @param block The block to execute when a new connection has been accepted. + * Returns whether the next incoming connection should be accepted + * by the specified block as well. + */ +- (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_accept_block_t)block; +#endif + +/*! + * @brief Cancels all pending asynchronous requests on the socket. + */ +- (void)cancelAsyncRequests; + +/*! + * @brief Closes the socket so that it can neither receive nor send any more + * datagrams. + */ +- (void)close; +@end + +OF_ASSUME_NONNULL_END ADDED src/OFSequencedPacketSocket.m Index: src/OFSequencedPacketSocket.m ================================================================== --- src/OFSequencedPacketSocket.m +++ src/OFSequencedPacketSocket.m @@ -0,0 +1,475 @@ +/* + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, + * 2018, 2019, 2020 + * Jonathan Schleifer + * + * 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. + */ + +#include "config.h" + +#include +#include + +#ifdef HAVE_FCNTL_H +# include +#endif + +#import "OFSequencedPacketSocket.h" +#import "OFData.h" +#import "OFRunLoop+Private.h" +#import "OFRunLoop.h" + +#import "OFAcceptFailedException.h" +#import "OFInitializationFailedException.h" +#import "OFInvalidArgumentException.h" +#import "OFListenFailedException.h" +#import "OFNotOpenException.h" +#import "OFOutOfRangeException.h" +#import "OFReadFailedException.h" +#import "OFSetOptionFailedException.h" +#import "OFWriteFailedException.h" + +#import "socket.h" +#import "socket_helpers.h" + +@implementation OFSequencedPacketSocket +@synthesize listening = _listening, delegate = _delegate; + ++ (void)initialize +{ + if (self != [OFSequencedPacketSocket class]) + return; + + if (!of_socket_init()) + @throw [OFInitializationFailedException + exceptionWithClass: self]; +} + ++ (instancetype)socket +{ + return [[[self alloc] init] autorelease]; +} + +- (instancetype)init +{ + self = [super init]; + + @try { + if (self.class == [OFSequencedPacketSocket class]) { + [self doesNotRecognizeSelector: _cmd]; + abort(); + } + + _socket = INVALID_SOCKET; + _blocking = true; + } @catch (id e) { + [self release]; + @throw e; + } + + return self; +} + +- (void)dealloc +{ + if (_socket != INVALID_SOCKET) + [self close]; + + [super dealloc]; +} + +- (id)copy +{ + return [self retain]; +} + +- (bool)isBlocking +{ + return _blocking; +} + +- (void)setBlocking: (bool)enable +{ +#if defined(HAVE_FCNTL) + int flags = fcntl(_socket, F_GETFL, 0); + + if (flags == -1) + @throw [OFSetOptionFailedException exceptionWithObject: self + errNo: errno]; + + if (enable) + flags &= ~O_NONBLOCK; + else + flags |= O_NONBLOCK; + + if (fcntl(_socket, F_SETFL, flags) == -1) + @throw [OFSetOptionFailedException exceptionWithObject: self + errNo: errno]; + + _blocking = enable; +#elif defined(OF_WINDOWS) + u_long v = enable; + + if (ioctlsocket(_socket, FIONBIO, &v) == SOCKET_ERROR) + @throw [OFSetOptionFailedException + exceptionWithObject: self + errNo: of_socket_errno()]; + + _blocking = enable; +#else + OF_UNRECOGNIZED_SELECTOR +#endif +} + +- (size_t)receiveIntoBuffer: (void *)buffer + length: (size_t)length +{ + ssize_t ret; + + if (_socket == INVALID_SOCKET) + @throw [OFNotOpenException exceptionWithObject: self]; + +#ifndef OF_WINDOWS + if ((ret = recv(_socket, buffer, length, 0)) < 0) + @throw [OFReadFailedException + exceptionWithObject: self + requestedLength: length + errNo: of_socket_errno()]; +#else + if (length > INT_MAX) + @throw [OFOutOfRangeException exception]; + + if ((ret = recv(_socket, buffer, (int)length, 0)) < 0) + @throw [OFReadFailedException + exceptionWithObject: self + requestedLength: length + errNo: of_socket_errno()]; +#endif + + return ret; +} + +- (void)asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length +{ + [self asyncReceiveIntoBuffer: buffer + length: length + runLoopMode: of_run_loop_mode_default]; +} + +- (void)asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + runLoopMode: (of_run_loop_mode_t)runLoopMode +{ + [OFRunLoop of_addAsyncReceiveForSequencedPacketSocket: self + buffer: buffer + length: length + mode: runLoopMode +# ifdef OF_HAVE_BLOCKS + block: NULL +# endif + delegate: _delegate]; +} + +#ifdef OF_HAVE_BLOCKS +- (void) + asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + block: (of_sequenced_packet_socket_async_receive_block_t) + block +{ + [self asyncReceiveIntoBuffer: buffer + length: length + runLoopMode: of_run_loop_mode_default + block: block]; +} + +- (void) + asyncReceiveIntoBuffer: (void *)buffer + length: (size_t)length + runLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_receive_block_t) + block +{ + [OFRunLoop of_addAsyncReceiveForSequencedPacketSocket: self + buffer: buffer + length: length + mode: runLoopMode + block: block + delegate: nil]; +} +#endif + +- (void)sendBuffer: (const void *)buffer + length: (size_t)length +{ + if (_socket == INVALID_SOCKET) + @throw [OFNotOpenException exceptionWithObject: self]; + +#ifndef OF_WINDOWS + ssize_t bytesWritten; + + if (length > SSIZE_MAX) + @throw [OFOutOfRangeException exception]; + + if ((bytesWritten = send(_socket, (void *)buffer, length, 0)) < 0) + @throw [OFWriteFailedException + exceptionWithObject: self + requestedLength: length + bytesWritten: 0 + errNo: of_socket_errno()]; +#else + int bytesWritten; + + if (length > INT_MAX) + @throw [OFOutOfRangeException exception]; + + if ((bytesWritten = send(_socket, buffer, (int)length, 0)) < 0) + @throw [OFWriteFailedException + exceptionWithObject: self + requestedLength: length + bytesWritten: 0 + errNo: of_socket_errno()]; +#endif + + if ((size_t)bytesWritten != length) + @throw [OFWriteFailedException exceptionWithObject: self + requestedLength: length + bytesWritten: bytesWritten + errNo: 0]; +} + +- (void)asyncSendData: (OFData *)data +{ + [self asyncSendData: data + runLoopMode: of_run_loop_mode_default]; +} + +- (void)asyncSendData: (OFData *)data + runLoopMode: (of_run_loop_mode_t)runLoopMode +{ + [OFRunLoop of_addAsyncSendForSequencedPacketSocket: self + data: data + mode: runLoopMode +# ifdef OF_HAVE_BLOCKS + block: NULL +# endif + delegate: _delegate]; +} + +#ifdef OF_HAVE_BLOCKS +- (void)asyncSendData: (OFData *)data + block: (of_sequenced_packet_socket_async_send_data_block_t)block +{ + [self asyncSendData: data + runLoopMode: of_run_loop_mode_default + block: block]; +} + +- (void)asyncSendData: (OFData *)data + runLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_send_data_block_t)block +{ + [OFRunLoop of_addAsyncSendForSequencedPacketSocket: self + data: data + mode: runLoopMode + block: block + delegate: nil]; +} +#endif + +- (void)listen +{ + [self listenWithBacklog: SOMAXCONN]; +} + +- (void)listenWithBacklog: (int)backlog +{ + if (_socket == INVALID_SOCKET) + @throw [OFNotOpenException exceptionWithObject: self]; + + if (listen(_socket, backlog) == -1) + @throw [OFListenFailedException + exceptionWithSocket: self + backlog: backlog + errNo: of_socket_errno()]; + + _listening = true; +} + +- (instancetype)accept +{ + OFSequencedPacketSocket *client = + [[[[self class] alloc] init] autorelease]; +#if (!defined(HAVE_PACCEPT) && !defined(HAVE_ACCEPT4)) || !defined(SOCK_CLOEXEC) +# if defined(HAVE_FCNTL) && defined(FD_CLOEXEC) + int flags; +# endif +#endif + + client->_remoteAddress.length = + (socklen_t)sizeof(client->_remoteAddress.sockaddr); + +#if defined(HAVE_PACCEPT) && defined(SOCK_CLOEXEC) + if ((client->_socket = paccept(_socket, + &client->_remoteAddress.sockaddr.sockaddr, + &client->_remoteAddress.length, NULL, SOCK_CLOEXEC)) == + INVALID_SOCKET) + @throw [OFAcceptFailedException + exceptionWithSocket: self + errNo: of_socket_errno()]; +#elif defined(HAVE_ACCEPT4) && defined(SOCK_CLOEXEC) + if ((client->_socket = accept4(_socket, + &client->_remoteAddress.sockaddr.sockaddr, + &client->_remoteAddress.length, SOCK_CLOEXEC)) == INVALID_SOCKET) + @throw [OFAcceptFailedException + exceptionWithSocket: self + errNo: of_socket_errno()]; +#else + if ((client->_socket = accept(_socket, + &client->_remoteAddress.sockaddr.sockaddr, + &client->_remoteAddress.length)) == INVALID_SOCKET) + @throw [OFAcceptFailedException + exceptionWithSocket: self + errNo: of_socket_errno()]; + +# if defined(HAVE_FCNTL) && defined(FD_CLOEXEC) + if ((flags = fcntl(client->_socket, F_GETFD, 0)) != -1) + fcntl(client->_socket, F_SETFD, flags | FD_CLOEXEC); +# endif +#endif + + assert(client->_remoteAddress.length <= + (socklen_t)sizeof(client->_remoteAddress.sockaddr)); + + switch (client->_remoteAddress.sockaddr.sockaddr.sa_family) { + case AF_INET: + client->_remoteAddress.family = OF_SOCKET_ADDRESS_FAMILY_IPV4; + break; +#ifdef OF_HAVE_IPV6 + case AF_INET6: + client->_remoteAddress.family = OF_SOCKET_ADDRESS_FAMILY_IPV6; + break; +#endif +#ifdef OF_HAVE_IPX + case AF_IPX: + client->_remoteAddress.family = OF_SOCKET_ADDRESS_FAMILY_IPX; + break; +#endif + default: + client->_remoteAddress.family = + OF_SOCKET_ADDRESS_FAMILY_UNKNOWN; + break; + } + + return client; +} + +- (void)asyncAccept +{ + [self asyncAcceptWithRunLoopMode: of_run_loop_mode_default]; +} + +- (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode +{ + [OFRunLoop of_addAsyncAcceptForSocket: self + mode: runLoopMode + block: NULL + delegate: _delegate]; +} + +#ifdef OF_HAVE_BLOCKS +- (void)asyncAcceptWithBlock: (of_sequenced_packet_socket_async_accept_block_t) + block +{ + [self asyncAcceptWithRunLoopMode: of_run_loop_mode_default + block: block]; +} + +- (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode + block: (of_sequenced_packet_socket_async_accept_block_t)block +{ + [OFRunLoop of_addAsyncAcceptForSocket: self + mode: runLoopMode + block: block + delegate: nil]; +} +#endif + +- (const of_socket_address_t *)remoteAddress +{ + if (_socket == INVALID_SOCKET) + @throw [OFNotOpenException exceptionWithObject: self]; + + if (_remoteAddress.length == 0) + @throw [OFInvalidArgumentException exception]; + + if (_remoteAddress.length > (socklen_t)sizeof(_remoteAddress.sockaddr)) + @throw [OFOutOfRangeException exception]; + + return &_remoteAddress; +} + +- (bool)isListening +{ + return _listening; +} + +- (void)cancelAsyncRequests +{ + [OFRunLoop of_cancelAsyncRequestsForObject: self + mode: of_run_loop_mode_default]; +} + +- (int)fileDescriptorForReading +{ +#ifndef OF_WINDOWS + return _socket; +#else + if (_socket == INVALID_SOCKET) + return -1; + + if (_socket > INT_MAX) + @throw [OFOutOfRangeException exception]; + + return (int)_socket; +#endif +} + +- (int)fileDescriptorForWriting +{ +#ifndef OF_WINDOWS + return _socket; +#else + if (_socket == INVALID_SOCKET) + return -1; + + if (_socket > INT_MAX) + @throw [OFOutOfRangeException exception]; + + return (int)_socket; +#endif +} + +- (void)close +{ + if (_socket == INVALID_SOCKET) + @throw [OFNotOpenException exceptionWithObject: self]; + + _listening = false; + memset(&_remoteAddress, 0, sizeof(_remoteAddress)); + + closesocket(_socket); + _socket = INVALID_SOCKET; +} +@end Index: src/OFStream.h ================================================================== --- src/OFStream.h +++ src/OFStream.h @@ -233,11 +233,11 @@ /*! * @brief The delegate for asynchronous operations on the stream. * * @note The delegate is retained for as long as asynchronous operations are - * still outstanding. + * still ongoing. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFStreamSocket.m ================================================================== --- src/OFStreamSocket.m +++ src/OFStreamSocket.m @@ -90,14 +90,14 @@ @throw [OFReadFailedException exceptionWithObject: self requestedLength: length errNo: of_socket_errno()]; #else - if (length > UINT_MAX) + if (length > INT_MAX) @throw [OFOutOfRangeException exception]; - if ((ret = recv(_socket, buffer, (unsigned int)length, 0)) < 0) + if ((ret = recv(_socket, buffer, (int)length, 0)) < 0) @throw [OFReadFailedException exceptionWithObject: self requestedLength: length errNo: of_socket_errno()]; #endif Index: src/OFTCPSocket.h ================================================================== --- src/OFTCPSocket.h +++ src/OFTCPSocket.h @@ -154,11 +154,11 @@ /*! * @brief The delegate for asynchronous operations on the socket. * * @note The delegate is retained for as long as asynchronous operations are - * still outstanding. + * still ongoing. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFTCPSocket.m ================================================================== --- src/OFTCPSocket.m +++ src/OFTCPSocket.m @@ -1039,16 +1039,14 @@ [self asyncAcceptWithRunLoopMode: of_run_loop_mode_default]; } - (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode { - [OFRunLoop of_addAsyncAcceptForTCPSocket: self - mode: runLoopMode -# ifdef OF_HAVE_BLOCKS - block: NULL -# endif - delegate: _delegate]; + [OFRunLoop of_addAsyncAcceptForSocket: self + mode: runLoopMode + block: NULL + delegate: _delegate]; } #ifdef OF_HAVE_BLOCKS - (void)asyncAcceptWithBlock: (of_tcp_socket_async_accept_block_t)block { @@ -1057,14 +1055,14 @@ } - (void)asyncAcceptWithRunLoopMode: (of_run_loop_mode_t)runLoopMode block: (of_tcp_socket_async_accept_block_t)block { - [OFRunLoop of_addAsyncAcceptForTCPSocket: self - mode: runLoopMode - block: block - delegate: nil]; + [OFRunLoop of_addAsyncAcceptForSocket: self + mode: runLoopMode + block: block + delegate: nil]; } #endif - (const of_socket_address_t *)remoteAddress { Index: src/OFUDPSocket.h ================================================================== --- src/OFUDPSocket.h +++ src/OFUDPSocket.h @@ -58,11 +58,11 @@ /*! * @brief The delegate for asynchronous operations on the socket. * * @note The delegate is retained for as long as asynchronous operations are - * still outstanding. + * still ongoing. */ @property OF_NULLABLE_PROPERTY (assign, nonatomic) id delegate; /*! Index: src/OFUDPSocket.m ================================================================== --- src/OFUDPSocket.m +++ src/OFUDPSocket.m @@ -59,12 +59,14 @@ } _blocking = true; #if SOCK_CLOEXEC == 0 && defined(HAVE_FCNTL) && defined(FD_CLOEXEC) - if ((flags = fcntl(_socket, F_GETFD, 0)) != -1) + /* {} needed to avoid warning with Clang 10 if next #if is false. */ + if ((flags = fcntl(_socket, F_GETFD, 0)) != -1) { fcntl(_socket, F_SETFD, flags | FD_CLOEXEC); + } #endif #if defined(OF_WII) || defined(OF_NINTENDO_3DS) if (of_socket_address_get_port(address) != 0) { #endif