OFSocket.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/>.
 */
 
#include "objfw-defs.h"
 
#ifndef OF_HAVE_SOCKETS
# error No sockets available!
#endif
 
#include <stdbool.h>
 
#import "OFString.h"
#if defined(OF_HAVE_THREADS) && defined(OF_AMIGAOS)
# import "OFTLSKey.h"
#endif
 
#ifdef OF_HAVE_SYS_SOCKET_H
# include <sys/socket.h>
#endif
#ifdef OF_HAVE_NETINET_IN_H
# include <netinet/in.h>
#endif
#ifdef OF_HAVE_NETINET_TCP_H
# include <netinet/tcp.h>
#endif
#ifdef OF_HAVE_SYS_UN_H
# include <sys/un.h>
#endif
#ifdef OF_HAVE_AFUNIX_H
# include <afunix.h>
#endif
#ifdef OF_HAVE_NETIPX_IPX_H
# include <netipx/ipx.h>
#endif
#if defined(OF_HAVE_NETAT_APPLETALK_H)
# include <netat/appletalk.h>
#elif defined(OF_HAVE_NETATALK_AT_H)
# include <netatalk/at.h>
#endif
 
#ifdef OF_WINDOWS
# include <windows.h>
# include <ws2tcpip.h>
# ifdef OF_HAVE_IPX
#  include <wsipx.h>
# endif
# ifdef OF_HAVE_APPLETALK
#  include <atalkwsh.h>
# endif
#endif
 
#ifdef OF_WII
# include <network.h>
#endif
 
#ifdef OF_PSP
# include <stdint.h>
#endif
 
#import "macros.h"
 
OF_ASSUME_NONNULL_BEGIN
 
#ifndef OF_WINDOWS
typedef int OFSocketHandle;
static const OFSocketHandle OFInvalidSocketHandle = -1;
#else
typedef SOCKET OFSocketHandle;
static const OFSocketHandle OFInvalidSocketHandle = INVALID_SOCKET;
#endif
 
#ifdef OF_WINDOWS
typedef short sa_family_t;
#endif
 
#ifdef OF_WII
typedef u8 sa_family_t;
#endif
 
#ifdef OF_MORPHOS
typedef long socklen_t;
typedef u_char sa_family_t;
typedef u_short in_port_t;
#endif
 
typedef enum {
    OFSocketAddressFamilyUnknown,
    OFSocketAddressFamilyIPv4,
    OFSocketAddressFamilyIPv6,
    OFSocketAddressFamilyUNIX,
    OFSocketAddressFamilyIPX,
    OFSocketAddressFamilyAppleTalk,
    OFSocketAddressFamilyAny = 255
} OFSocketAddressFamily;
 
#ifndef OF_HAVE_IPV6
struct sockaddr_in6 {
    sa_family_t sin6_family;
    in_port_t sin6_port;
    uint32_t sin6_flowinfo;
    struct in6_addr {
        uint8_t s6_addr[16];
    } sin6_addr;
    uint32_t sin6_scope_id;
};
#endif
 
#if !defined(OF_HAVE_UNIX_SOCKETS) && !defined(OF_MORPHOS) && !defined(OF_MINT)
struct sockaddr_un {
    sa_family_t sun_family;
    char sun_path[108];
};
#endif
 
#ifndef IPX_NODE_LEN
# define IPX_NODE_LEN 6
#endif
#if !defined(OF_HAVE_IPX)
struct sockaddr_ipx {
    sa_family_t sipx_family;
    uint32_t sipx_network;
    unsigned char sipx_node[IPX_NODE_LEN];
    uint16_t sipx_port;
    uint8_t sipx_type;
};
#elif defined(OF_WINDOWS)
# define IPX_NODE_LEN 6
# define sipx_family sa_family
# define sipx_network sa_netnum
# define sipx_node sa_nodenum
# define sipx_port sa_socket
#elif defined(OF_FREEBSD)
# define sipx_network sipx_addr.x_net.c_net
# define sipx_node sipx_addr.x_host.c_host
#endif
 
#ifndef OF_HAVE_APPLETALK
struct sockaddr_at {
    sa_family_t sat_family;
    uint8_t sat_port;
    uint16_t sat_net;
    uint8_t sat_node;
};
#else
# ifdef OF_WINDOWS
#  define sat_port sat_socket
# else
#  define sat_net sat_addr.s_net
#  define sat_node sat_addr.s_node
# endif
#endif
 
typedef struct OF_BOXABLE OFSocketAddress {
    OFSocketAddressFamily family;
    /*
     * We can't use struct sockaddr as it can contain variable length
     * arrays.
     */
    union {
        struct sockaddr_in in;
        struct sockaddr_in6 in6;
        struct sockaddr_un un;
        struct sockaddr_ipx ipx;
        struct sockaddr_at at;
#ifdef OF_HAVE_SOCKADDR_STORAGE
        /*
         * Required to make the ABI stable in case we want to add more
         * address types later.
         */
        struct sockaddr_storage storage;
#endif
    } sockaddr;
    socklen_t length;
} OFSocketAddress;
 
#ifdef __cplusplus
extern "C" {
#endif
extern OFSocketAddress OFSocketAddressParseIP(OFString *IP, uint16_t port);
 
extern OFSocketAddress OFSocketAddressParseIPv4(OFString *IP, uint16_t port);
 
extern OFSocketAddress OFSocketAddressParseIPv6(OFString *IP, uint16_t port);
 
extern OFSocketAddress OFSocketAddressMakeUNIX(OFString *path);
 
extern OFSocketAddress OFSocketAddressMakeIPX(uint32_t network,
    const unsigned char node[_Nonnull IPX_NODE_LEN], uint16_t port);
 
extern OFSocketAddress OFSocketAddressMakeAppleTalk(uint16_t network,
    uint8_t node, uint8_t port);
 
extern bool OFSocketAddressEqual(const OFSocketAddress *_Nonnull address1,
    const OFSocketAddress *_Nonnull address2);
 
extern unsigned long OFSocketAddressHash(
    const OFSocketAddress *_Nonnull address);
 
extern OFString *_Nonnull OFSocketAddressString(
    const OFSocketAddress *_Nonnull address);
 
extern OFString *_Nonnull OFSocketAddressDescription(
    const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetIPPort(OFSocketAddress *_Nonnull address,
    uint16_t port);
 
extern uint16_t OFSocketAddressIPPort(const OFSocketAddress *_Nonnull address);
 
extern OFString *OFSocketAddressUNIXPath(
    const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetIPXNetwork(OFSocketAddress *_Nonnull address,
    uint32_t network);
 
extern uint32_t OFSocketAddressIPXNetwork(
    const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetIPXNode(OFSocketAddress *_Nonnull address,
    const unsigned char node[_Nonnull IPX_NODE_LEN]);
 
extern void OFSocketAddressGetIPXNode(const OFSocketAddress *_Nonnull address,
    unsigned char node[_Nonnull IPX_NODE_LEN]);
 
extern void OFSocketAddressSetIPXPort(OFSocketAddress *_Nonnull address,
    uint16_t port);
 
extern uint16_t OFSocketAddressIPXPort(const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetAppleTalkNetwork(
    OFSocketAddress *_Nonnull address, uint16_t network);
 
extern uint16_t OFSocketAddressAppleTalkNetwork(
    const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetAppleTalkNode(OFSocketAddress *_Nonnull address,
    uint8_t node);
 
extern uint8_t OFSocketAddressAppleTalkNode(
    const OFSocketAddress *_Nonnull address);
 
extern void OFSocketAddressSetAppleTalkPort(OFSocketAddress *_Nonnull address,
    uint8_t port);
 
extern uint8_t OFSocketAddressAppleTalkPort(
    const OFSocketAddress *_Nonnull address);
 
extern bool OFSocketInit(void);
#if defined(OF_HAVE_THREADS) && defined(OF_AMIGAOS) && !defined(OF_MORPHOS)
extern void OFSocketDeinit(void);
#endif
extern int OFSocketErrNo(void);
#if !defined(OF_WII) && !defined(OF_NINTENDO_3DS)
extern int OFGetSockName(OFSocketHandle sock, struct sockaddr *restrict addr,
    socklen_t *restrict addrLen);
#endif
 
#if defined(OF_HAVE_THREADS) && defined(OF_AMIGAOS) && !defined(OF_MORPHOS)
extern OFTLSKey OFSocketBaseKey;
# ifdef OF_AMIGAOS4
extern OFTLSKey OFSocketInterfaceKey;
# endif
#endif
#ifdef __cplusplus
}
#endif
 
OF_ASSUME_NONNULL_END