OFTCPSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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 "OFStreamSocket.h"

#import "socket.h"

OF_ASSUME_NONNULL_BEGIN

@class OFTCPSocket;
@class OFString;

#ifdef OF_HAVE_BLOCKS

typedef void (^of_tcp_socket_async_connect_block_t)(OFTCPSocket *socket,
    OFException *OF_NULLABLE exception);

typedef bool (^of_tcp_socket_async_accept_block_t)(OFTCPSocket *socket,
    OFTCPSocket *acceptedSocket, OFException *OF_NULLABLE exception);
#endif

@interface OFTCPSocket: OFStreamSocket
{
    bool _listening;
    struct sockaddr *_address;
    socklen_t _addressLength;
    OFString *_SOCKS5Host;
    uint16_t _SOCKS5Port;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, getter=isListening) bool listening;
@property OF_NULLABLE_PROPERTY (copy) OFString *SOCKS5Host;
@property uint16_t SOCKS5Port;
@property (getter=isKeepAliveEnabled) bool keepAliveEnabled;
@property (getter=isTCPNoDelayEnabled) bool TCPNoDelayEnabled;
#endif

+ (void)setSOCKS5Host: (nullable OFString*)SOCKS5Host;

+ (nullable OFString*)SOCKS5Host;

+ (void)setSOCKS5Port: (uint16_t)SOCKS5Port;

+ (uint16_t)SOCKS5Port;

- (void)setSOCKS5Host: (nullable OFString*)host;

- (nullable OFString*)SOCKS5Host;

- (void)setSOCKS5Port: (uint16_t)port;

- (uint16_t)SOCKS5Port;

- (void)connectToHost: (OFString*)host
         port: (uint16_t)port;

#ifdef OF_HAVE_THREADS

- (void)asyncConnectToHost: (OFString*)host
              port: (uint16_t)port
            target: (id)target
          selector: (SEL)selector;

# ifdef OF_HAVE_BLOCKS

- (void)asyncConnectToHost: (OFString*)host
              port: (uint16_t)port
             block: (of_tcp_socket_async_connect_block_t)block;
# endif
#endif

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

- (void)listenWithBackLog: (int)backLog;

- (void)listen;

- (instancetype)accept;

- (void)asyncAcceptWithTarget: (id)target
             selector: (SEL)selector;

#ifdef OF_HAVE_BLOCKS

- (void)asyncAcceptWithBlock: (of_tcp_socket_async_accept_block_t)block;
#endif

- (nullable OFString*)remoteAddress;

- (bool)isListening;

- (void)setKeepAliveEnabled: (bool)enabled;

- (bool)isKeepAliveEnabled;

- (void)setTCPNoDelayEnabled: (bool)enabled;

- (bool)isTCPNoDelayEnabled;
@end

#ifdef __cplusplus
extern "C" {
#endif
extern Class OF_NULLABLE of_tls_socket_class;
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END