OFUDPSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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 "socket.h"

OF_ASSUME_NONNULL_BEGIN

@class OFUDPSocket;
@class OFException;

typedef struct {
    struct sockaddr_storage address;
    socklen_t length;
} of_udp_socket_address_t;

#ifdef OF_HAVE_BLOCKS

typedef void (^of_udp_socket_async_resolve_block_t)(OFString *host,
    uint16_t port, of_udp_socket_address_t address,
    OFException *_Nullable exception);

typedef bool (^of_udp_socket_async_receive_block_t)(OFUDPSocket *socket,
    void *buffer, size_t length, of_udp_socket_address_t sender,
    OFException *_Nullable exception);
#endif

@interface OFUDPSocket: OFObject <OFCopying, OFReadyForReadingObserving,
    OFReadyForWritingObserving>
{
    of_socket_t _socket;
#ifdef OF_WII
    uint16_t _port;
#endif
}

+ (instancetype)socket;

+ (void)resolveAddressForHost: (OFString *)host
             port: (uint16_t)port
              address: (of_udp_socket_address_t *)address;

#ifdef OF_HAVE_THREADS

+ (void)asyncResolveAddressForHost: (OFString *)host
                  port: (uint16_t)port
                target: (id)target
              selector: (SEL)selector;

# ifdef OF_HAVE_BLOCKS

+ (void)asyncResolveAddressForHost: (OFString *)host
                  port: (uint16_t)port
                 block: (of_udp_socket_async_resolve_block_t)block;
# endif
#endif

+ (void)getHost: (OFString *__autoreleasing _Nonnull *_Nullable)host
    andPort: (nullable uint16_t *)port
     forAddress: (of_udp_socket_address_t *)address;

- (uint16_t)bindToHost: (OFString *)host
          port: (uint16_t)port;

- (size_t)receiveIntoBuffer: (void *)buffer
             length: (size_t)length
             sender: (of_udp_socket_address_t *)sender;

- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
            target: (id)target
              selector: (SEL)selector;

#ifdef OF_HAVE_BLOCKS

- (void)asyncReceiveIntoBuffer: (void *)buffer
            length: (size_t)length
             block: (of_udp_socket_async_receive_block_t)block;
#endif

- (void)sendBuffer: (const void *)buffer
        length: (size_t)length
      receiver: (const of_udp_socket_address_t *)receiver;

- (void)cancelAsyncRequests;

- (void)close;
@end

#ifdef __cplusplus
extern "C" {
#endif

extern bool of_udp_socket_address_equal(of_udp_socket_address_t *address1,
    of_udp_socket_address_t *address2);

extern uint32_t of_udp_socket_address_hash(of_udp_socket_address_t *address);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END