/* * Copyright (c) 2008-2023 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 "OFDatagramSocket.h" OF_ASSUME_NONNULL_BEGIN @class OFString; @class OFDictionary OF_GENERIC(KeyType, ObjectType); #ifdef OF_HAVE_APPLETALK_IFCONFIG /** * @brief A dictionary mapping keys of type @ref * OFAppleTalkInterfaceConfigurationKey. */ typedef OFConstantString *OFAppleTalkInterfaceConfigurationKey; /** * @brief A key for OFAppleTalkInterfaceConfiguration. * * Possible keys are: * * @ref OFAppleTalkInterfaceConfigurationNetwork * * @ref OFAppleTalkInterfaceConfigurationNode * * @ref OFAppleTalkInterfaceConfigurationPhase * * @ref OFAppleTalkInterfaceConfigurationNetworkRange */ typedef OFDictionary OF_GENERIC(OFAppleTalkInterfaceConfigurationKey, id) *OFAppleTalkInterfaceConfiguration; /** * @brief The AppleTalk network of an interface. * * The corresponding value is of type @ref OFNumber in the range 0 to 65535. */ extern const OFAppleTalkInterfaceConfigurationKey OFAppleTalkInterfaceConfigurationNetwork; /** * @brief The AppleTalk node of an interface. * * The corresponding value is of type @ref OFNumber in the range 0 to 255. */ extern const OFAppleTalkInterfaceConfigurationKey OFAppleTalkInterfaceConfigurationNode; /** * @brief The AppleTalk phase of an interface. * * The corresponding value is of type @ref OFNumber in the range 1 to 2. */ extern const OFAppleTalkInterfaceConfigurationKey OFAppleTalkInterfaceConfigurationPhase; /** * @brief The AppleTalk network range of an interface. * * The corresponding value is of type @ref OFPair with two @ref OFNumber, both * in the range 0 to 65535. */ extern const OFAppleTalkInterfaceConfigurationKey OFAppleTalkInterfaceConfigurationNetworkRange; #endif /** * @protocol OFDDPSocketDelegate OFDDPSocket.h ObjFW/OFDDPSocket.h * * @brief A delegate for OFDDPSocket. */ @protocol OFDDPSocketDelegate @end /** * @class OFDDPSocket OFDDPSocket.h ObjFW/OFDDPSocket.h * * @brief A class which provides methods to create and use AppleTalk DDP * sockets. * * Addresses are of type @ref OFSocketAddress. You can use * @ref OFSocketAddressMakeAppleTalk to create an address or * @ref OFSocketAddressAppleTalkNetwork to get the AppleTalk network, * @ref OFSocketAddressAppleTalkNode to get the AppleTalk node and * @ref OFSocketAddressAppleTalkPort to get the port (sometimes also called * socket number). * * @note On some systems, packets received with the wrong protocol type just * get filtered by the kernel, however, on other systems, the packet is * queued up and will raise an @ref OFReadFailedException with the * @ref OFReadFailedException#errNo set to `ENOMSG` when being received. * * @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 OFDDPSocket: OFDatagramSocket { #if !defined(OF_MACOS) && !defined(OF_WINDOWS) uint8_t _protocolType; #endif OF_RESERVE_IVARS(OFDDPSocket, 4) } /** * @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; #ifdef OF_HAVE_APPLETALK_IFCONFIG /** * @brief Configures the specified interface with the specified AppleTalk * configuration. * * @param configuration The AppleTalk configuration for the interface. See * @ref OFAppleTalkInterfaceConfiguration for more * details. * @param interfaceName The name of the interface to configure for AppleTalk * @throw OFSetOptionFailedException Setting the configuration failed. Consult * errNo for details. */ + (void)setConfiguration: (OFAppleTalkInterfaceConfiguration)configuration forInterface: (OFString *)interfaceName; /** * @brief Returns the AppleTalk configuration for the specified interface. * * @param interfaceName The name of the interface for which to return the * AppleTalk configuration * @return The AppleTalk configuration for the specified interface, or `nil` if * the specified interface is not configured for AppleTalk. See * @ref OFAppleTalkInterfaceConfiguration for more details. * @throw OFGetOptionFailedException Getting the configuration failed. Consult * errNo for details. */ + (nullable OFAppleTalkInterfaceConfiguration) configurationForInterface: (OFString *)interfaceName; /** * @brief Removes the AppleTalk configuration for the specified interface. * * @param interfaceName The name of the interface for which to remove the * AppleTalk configuration * @throw OFSetOptionFailedException Removing the configuration failed. Consult * errNo for details. */ + (void)removeConfigurationForInterface: (OFString *)interfaceName; #endif /** * @brief Bind the socket to the specified network, node and port. * * @param network The network to bind to. 0 means any. * @param node The node to bind to. 0 means "this node". * @param port The port to bind to. 0 means to pick one and return it via the * returned socket address. * @param protocolType The DDP protocol type to use. Must not be 0. If you want * to use DDP directly and not a protocol built on top of * it, use 11 for compatibility with Open Transport. * @return The address on which this socket can be reached * @throw OFBindDDPSockeFailedException Binding failed * @throw OFAlreadyOpenException The socket is already bound */ - (OFSocketAddress)bindToNetwork: (uint16_t)network node: (uint8_t)node port: (uint8_t)port protocolType: (uint8_t)protocolType; @end OF_ASSUME_NONNULL_END