OFTCPSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2025 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 "OFStreamSocket.h"
#import "OFRunLoop.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFTCPSocket;
@class OFString;
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFTCPSocketAsyncConnectBlock)(id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2, "Use OFTCPSocketConnecetedHandler instead");
 
typedef void (^OFTCPSocketConnectedHandler)(OFTCPSocket *socket,
    OFString *host, uint16_t port, id _Nullable exception);
#endif
 
@protocol OFTCPSocketDelegate <OFStreamSocketDelegate>
@optional
-     (void)socket: (OFTCPSocket *)socket
  didConnectToHost: (OFString *)host
          port: (uint16_t)port
     exception: (nullable id)exception;
@end
 
@interface OFTCPSocket: OFStreamSocket
{
    OFString *_Nullable _SOCKS5Host;
    uint16_t _SOCKS5Port;
#ifdef OF_WII
    uint16_t _port;
#endif
    uintptr_t _flags;   /* Change to a smaller type on ABI bump */
    OF_RESERVE_IVARS(OFTCPSocket, 3)
}
 
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, nullable, copy, nonatomic) OFString *SOCKS5Host;
@property (class, nonatomic) uint16_t SOCKS5Port;
#endif
 
#if !defined(OF_WII) && !defined(OF_NINTENDO_3DS)
@property (nonatomic) bool sendsKeepAlives;
#endif
 
#ifndef OF_WII
@property (nonatomic) bool canDelaySendingSegments;
#endif
 
@property (nonatomic) bool allowsMPTCP;
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *SOCKS5Host;
 
@property (nonatomic) uint16_t SOCKS5Port;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFTCPSocketDelegate> delegate;
 
+ (void)setSOCKS5Host: (nullable OFString *)SOCKS5Host;
 
+ (nullable OFString *)SOCKS5Host;
 
+ (void)setSOCKS5Port: (uint16_t)SOCKS5Port;
 
+ (uint16_t)SOCKS5Port;
 
- (void)connectToHost: (OFString *)host port: (uint16_t)port;
 
- (void)asyncConnectToHost: (OFString *)host port: (uint16_t)port;
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
             block: (OFTCPSocketAsyncConnectBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncConnectToHost:port:handler:] instead");
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           handler: (OFTCPSocketConnectedHandler)handler;
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           runLoopMode: (OFRunLoopMode)runLoopMode
             block: (OFTCPSocketAsyncConnectBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncConnectToHost:port:runLoopMode:handler:] instead");
 
- (void)asyncConnectToHost: (OFString *)host
              port: (uint16_t)port
           runLoopMode: (OFRunLoopMode)runLoopMode
           handler: (OFTCPSocketConnectedHandler)handler;
#endif
 
- (OFSocketAddress)bindToHost: (OFString *)host port: (uint16_t)port;
@end
 
OF_ASSUME_NONNULL_END