OFSPXSocket.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 "OFSequencedPacketSocket.h"
#import "OFRunLoop.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFSPXSocket;
@class OFString;
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFSPXSocketAsyncConnectBlock)(id _Nullable exception)
    OF_DEPRECATED(ObjFW, 1, 2, "Use OFSPXSocketConnectedHandler instead");
 
typedef void (^OFSPXSocketConnectedHandler)(OFSPXSocket *socket,
    uint32_t network, const unsigned char node[_Nonnull IPX_NODE_LEN],
    uint16_t port, id _Nullable exception);
#endif
 
@protocol OFSPXSocketDelegate <OFSequencedPacketSocketDelegate>
@optional
-    (void)socket: (OFSPXSocket *)socket
  didConnectToNetwork: (uint32_t)network
         node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
         port: (uint16_t)port
        exception: (nullable id)exception;
@end
 
@interface OFSPXSocket: OFSequencedPacketSocket
{
    OF_RESERVE_IVARS(OFSPXSocket, 4)
}
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFSPXSocketDelegate> delegate;
 
- (void)connectToNetwork: (uint32_t)network
            node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
            port: (uint16_t)port;
 
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port;
 
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port
          runLoopMode: (OFRunLoopMode)runLoopMode;
 
#ifdef OF_HAVE_BLOCKS
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port
            block: (OFSPXSocketAsyncConnectBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncConnectToNetwork:node:port:handler:] instead");
 
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port
              handler: (OFSPXSocketConnectedHandler)handler;
 
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port
          runLoopMode: (OFRunLoopMode)runLoopMode
            block: (OFSPXSocketAsyncConnectBlock)block
    OF_DEPRECATED(ObjFW, 1, 2,
    "Use -[asyncConnectToNetwork:node:port:runLoopMode:handler:] instead");
 
- (void)asyncConnectToNetwork: (uint32_t)network
             node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
             port: (uint16_t)port
          runLoopMode: (OFRunLoopMode)runLoopMode
              handler: (OFSPXSocketConnectedHandler)handler;
#endif
 
- (OFSocketAddress)
    bindToNetwork: (uint32_t)network
         node: (const unsigned char [_Nonnull IPX_NODE_LEN])node
         port: (uint16_t)port;
@end
 
OF_ASSUME_NONNULL_END