UDPC.h

Go to the documentation of this file.

 
#ifndef UDPC_CONNECTION_H
#define UDPC_CONNECTION_H
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
// Determine platform macros
# define UDPC_PLATFORM_WINDOWS 1
# define UDPC_PLATFORM_MAC 2
# define UDPC_PLATFORM_LINUX 3
# define UDPC_PLATFORM_UNKNOWN 0
 
# if defined _WIN32
#  define UDPC_PLATFORM UDPC_PLATFORM_WINDOWS
# elif defined __APPLE__
#  define UDPC_PLATFORM UDPC_PLATFORM_MAC
# elif defined __linux__
#  define UDPC_PLATFORM UDPC_PLATFORM_LINUX
# else
#  define UDPC_PLATFORM UDPC_PLATFORM_UNKNOWN
# endif
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
// OS-based networking macros
#if UDPC_PLATFORM == UDPC_PLATFORM_WINDOWS
# include <winsock2.h>
# ifdef UDPC_PLATFORM_MINGW
#  include <ws2ipdef.h>
#  include <in6addr.h>
# else
#  include <Ws2ipdef.h>
#  include <In6addr.h>
# endif
 
# ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  define UDPC_CLEANUPSOCKET(x) closesocket(x)
#  define UDPC_SOCKETTYPE SOCKET
#  define UDPC_IPV6_SOCKADDR_TYPE SOCKADDR_IN6
#  define UDPC_IPV6_ADDR_TYPE IN6_ADDR
#  define UDPC_IPV6_ADDR_SUB(addr) addr.u.Byte
#  define UDPC_SOCKET_RETURN_ERROR(socket) (socket == INVALID_SOCKET)
 
# endif // DOXYGEN_SHOULD_SKIP_THIS
 
#elif UDPC_PLATFORM == UDPC_PLATFORM_MAC || UDPC_PLATFORM == UDPC_PLATFORM_LINUX
# include <fcntl.h>
# include <netinet/in.h>
# include <sys/socket.h>
# include <unistd.h>
 
# ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  define UDPC_CLEANUPSOCKET(x) close(x)
#  define UDPC_SOCKETTYPE int
#  define UDPC_IPV6_SOCKADDR_TYPE struct sockaddr_in6
#  define UDPC_IPV6_ADDR_TYPE struct in6_addr
#  define UDPC_IPV6_ADDR_SUB(addr) addr.s6_addr
#  define UDPC_SOCKET_RETURN_ERROR(socket) (socket <= 0)
 
# endif // DOXYGEN_SHOULD_SKIP_THIS
 
#else
# ifndef DOXYGEN_SHOULD_SKIP_THIS
#  define UDPC_CLEANUPSOCKET(x) ((void)0)
# endif // DOXYGEN_SHOULD_SKIP_THIS
#endif
 
// other defines
#define UDPC_PACKET_MAX_SIZE 8192
#define UDPC_DEFAULT_PROTOCOL_ID 1357924680 // 0x50f04948
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
// other defines continued
 
# ifndef UDPC_LIBSODIUM_ENABLED
#  ifndef crypto_sign_PUBLICKEYBYTES
#   define crypto_sign_PUBLICKEYBYTES 1
#  endif
#  ifndef crypto_sign_SECRETKEYBYTES
#   define crypto_sign_SECRETKEYBYTES 1
#  endif
#  ifndef crypto_sign_BYTES
#   define crypto_sign_BYTES 1
#  endif
# endif
 
# if UDPC_PLATFORM == UDPC_PLATFORM_WINDOWS
#  define UDPC_EXPORT __declspec(dllexport)
# else
#  define UDPC_EXPORT
# endif
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef __cplusplus
# include <cstdint>
extern "C" {
#else
# include <stdint.h>
#endif
 
struct UDPC_Context;
typedef struct UDPC_Context *UDPC_HContext;
 
typedef enum UDPC_EXPORT UDPC_LoggingType {
    UDPC_SILENT,
    UDPC_ERROR,
    UDPC_WARNING,
    UDPC_INFO,
    UDPC_VERBOSE,
    UDPC_DEBUG
} UDPC_LoggingType;
 
typedef enum UDPC_EXPORT UDPC_AuthPolicy {
    UDPC_AUTH_POLICY_FALLBACK=0,
    UDPC_AUTH_POLICY_STRICT,
    // Used internally to get max size of enum
    UDPC_AUTH_POLICY_SIZE
} UDPC_AuthPolicy;
 
typedef struct UDPC_EXPORT UDPC_ConnectionId {
    UDPC_IPV6_ADDR_TYPE addr;
    uint32_t scope_id;
    uint16_t port;
} UDPC_ConnectionId;
 
typedef struct UDPC_EXPORT UDPC_PacketInfo {
    // id is stored at offset 8, size 4 (uint32_t) even for "empty" PktInfos
    char *data;
    uint32_t flags;
    uint32_t id;
    uint16_t dataSize;
    uint16_t rtt;
    UDPC_ConnectionId sender;
    UDPC_ConnectionId receiver;
} UDPC_PacketInfo;
 
typedef enum UDPC_EXPORT UDPC_EventType {
    UDPC_ET_NONE,
    UDPC_ET_REQUEST_CONNECT,
    UDPC_ET_REQUEST_DISCONNECT,
    UDPC_ET_CONNECTED,
    UDPC_ET_DISCONNECTED,
    UDPC_ET_FAIL_CONNECT,
    UDPC_ET_GOOD_MODE,
    UDPC_ET_BAD_MODE
} UDPC_EventType;
 
typedef struct UDPC_EXPORT UDPC_Event {
    UDPC_EventType type;
    UDPC_ConnectionId conId;
    union Value {
        int dropAllWithAddr;
        int enableLibSodium;
    } v;
} UDPC_Event;
 
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id(UDPC_IPV6_ADDR_TYPE addr, uint16_t port);
 
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_full(UDPC_IPV6_ADDR_TYPE addr, uint32_t scope_id, uint16_t port);
 
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_anyaddr(uint16_t port);
 
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_easy(const char *addrString, uint16_t port);
 
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_hostname(const char *hostname, uint16_t port);
 
UDPC_EXPORT UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium);
UDPC_EXPORT UDPC_HContext UDPC_init_threaded_update(
    UDPC_ConnectionId listenId,
    int isClient,
    int isUsingLibsodium);
UDPC_EXPORT UDPC_HContext UDPC_init_threaded_update_ms(
    UDPC_ConnectionId listenId,
    int isClient,
    int updateMS,
    int isUsingLibsodium);
 
UDPC_EXPORT int UDPC_enable_threaded_update(UDPC_HContext ctx);
UDPC_EXPORT int UDPC_enable_threaded_update_ms(UDPC_HContext ctx, int updateMS);
UDPC_EXPORT int UDPC_disable_threaded_update(UDPC_HContext ctx);
 
UDPC_EXPORT int UDPC_is_valid_context(UDPC_HContext ctx);
 
UDPC_EXPORT void UDPC_destroy(UDPC_HContext ctx);
 
UDPC_EXPORT void UDPC_update(UDPC_HContext ctx);
 
UDPC_EXPORT void UDPC_client_initiate_connection(
    UDPC_HContext ctx,
    UDPC_ConnectionId connectionId,
    int enableLibSodium);
 
UDPC_EXPORT void UDPC_queue_send(UDPC_HContext ctx, UDPC_ConnectionId destinationId,
                     int isChecked, const void *data, uint32_t size);
 
UDPC_EXPORT unsigned long UDPC_get_queue_send_current_size(UDPC_HContext ctx);
 
UDPC_EXPORT unsigned long UDPC_get_queued_size(UDPC_HContext ctx, UDPC_ConnectionId id, int *exists);
 
UDPC_EXPORT unsigned long UDPC_get_max_queued_size();
 
UDPC_EXPORT int UDPC_set_accept_new_connections(UDPC_HContext ctx, int isAccepting);
 
UDPC_EXPORT void UDPC_drop_connection(UDPC_HContext ctx, UDPC_ConnectionId connectionId, int dropAllWithAddr);
 
UDPC_EXPORT int UDPC_has_connection(UDPC_HContext ctx, UDPC_ConnectionId connectionId);
 
UDPC_EXPORT UDPC_ConnectionId* UDPC_get_list_connected(UDPC_HContext ctx, unsigned int *size);
 
UDPC_EXPORT void UDPC_free_list_connected(UDPC_ConnectionId *list);
 
UDPC_EXPORT uint32_t UDPC_get_protocol_id(UDPC_HContext ctx);
 
UDPC_EXPORT uint32_t UDPC_set_protocol_id(UDPC_HContext ctx, uint32_t id);
 
UDPC_EXPORT UDPC_LoggingType UDPC_get_logging_type(UDPC_HContext ctx);
 
UDPC_EXPORT UDPC_LoggingType UDPC_set_logging_type(UDPC_HContext ctx, UDPC_LoggingType loggingType);
 
UDPC_EXPORT int UDPC_get_receiving_events(UDPC_HContext ctx);
 
UDPC_EXPORT int UDPC_set_receiving_events(UDPC_HContext ctx, int isReceivingEvents);
 
UDPC_EXPORT UDPC_Event UDPC_get_event(UDPC_HContext ctx, unsigned long *remaining);
 
UDPC_EXPORT UDPC_PacketInfo UDPC_get_received(UDPC_HContext ctx, unsigned long *remaining);
 
UDPC_EXPORT void UDPC_free_PacketInfo(UDPC_PacketInfo pInfo);
 
UDPC_EXPORT void UDPC_free_PacketInfo_ptr(UDPC_PacketInfo *pInfoPtr);
 
UDPC_EXPORT int UDPC_set_libsodium_keys(UDPC_HContext ctx, const unsigned char *sk, const unsigned char *pk);
 
UDPC_EXPORT int UDPC_set_libsodium_key_easy(UDPC_HContext ctx, const unsigned char *sk);
 
UDPC_EXPORT int UDPC_unset_libsodium_keys(UDPC_HContext ctx);
 
UDPC_EXPORT int UDPC_add_whitelist_pk(UDPC_HContext ctx, const unsigned char *pk);
 
UDPC_EXPORT int UDPC_has_whitelist_pk(UDPC_HContext ctx, const unsigned char *pk);
 
UDPC_EXPORT int UDPC_remove_whitelist_pk(UDPC_HContext ctx, const unsigned char *pk);
 
UDPC_EXPORT int UDPC_clear_whitelist(UDPC_HContext ctx);
 
UDPC_EXPORT int UDPC_get_auth_policy(UDPC_HContext ctx);
 
UDPC_EXPORT int UDPC_set_auth_policy(UDPC_HContext ctx, int value);
 
UDPC_EXPORT const char *UDPC_atostr_cid(UDPC_HContext ctx, UDPC_ConnectionId connectionId);
 
UDPC_EXPORT const char *UDPC_atostr(UDPC_HContext ctx, UDPC_IPV6_ADDR_TYPE addr);
 
UDPC_EXPORT const char *UDPC_atostr_unsafe(UDPC_IPV6_ADDR_TYPE addr);
 
UDPC_EXPORT const char *UDPC_atostr_unsafe_cid(UDPC_ConnectionId cid);
 
UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf);
 
UDPC_EXPORT void UDPC_atostr_unsafe_free_ptr(const char **addrBuf);
 
// There used to be a `UDPC_set_heartbeat_millis(...)` function here, but it
// was determined that it would be better not to implement it. Details here:
// https://github.com/Stephen-Seo/UDPConnection/issues/2
 
// =============================================================================
// Helpers
 
UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa(const char *addrStr);
 
UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(const char *addrStr, uint32_t *linkId_out);
 
UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_a4toa6(uint32_t a4_be);
 
UDPC_EXPORT int UDPC_is_big_endian();
 
UDPC_EXPORT uint16_t UDPC_no16i(uint16_t i);
 
UDPC_EXPORT uint32_t UDPC_no32i(uint32_t i);
 
UDPC_EXPORT uint64_t UDPC_no64i(uint64_t i);
 
UDPC_EXPORT float UDPC_no32f(float f);
 
UDPC_EXPORT double UDPC_no64f(double f);
 
#ifdef __cplusplus
}
#endif
#endif