2019-12-04 04:08:30 +00:00
|
|
|
/*!
|
|
|
|
* \mainpage UDPConnection
|
|
|
|
* \ref UDPConnection.h
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* \file UDPConnection.h
|
|
|
|
* \brief Public API for UDPConnection
|
|
|
|
*/
|
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
#ifndef UDPC_CONNECTION_H
|
|
|
|
#define UDPC_CONNECTION_H
|
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
// Determine platform macros
|
2019-12-04 04:08:30 +00:00
|
|
|
# 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
|
2019-06-06 07:02:48 +00:00
|
|
|
|
|
|
|
// OS-based networking macros
|
|
|
|
#if UDPC_PLATFORM == UDPC_PLATFORM_WINDOWS
|
2019-12-04 04:08:30 +00:00
|
|
|
# include <winsock2.h>
|
2019-09-21 03:15:49 +00:00
|
|
|
# ifdef UDPC_PLATFORM_MINGW
|
|
|
|
# include <ws2ipdef.h>
|
|
|
|
# include <in6addr.h>
|
|
|
|
# else
|
|
|
|
# include <Ws2ipdef.h>
|
|
|
|
# include <In6addr.h>
|
|
|
|
# endif
|
2019-09-19 03:23:15 +00:00
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
# 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
|
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
#elif UDPC_PLATFORM == UDPC_PLATFORM_MAC || UDPC_PLATFORM == UDPC_PLATFORM_LINUX
|
2019-12-04 04:08:30 +00:00
|
|
|
# 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
|
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
#else
|
2019-12-04 04:08:30 +00:00
|
|
|
# ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
# define UDPC_CLEANUPSOCKET(x) ((void)0)
|
|
|
|
# endif // DOXYGEN_SHOULD_SKIP_THIS
|
2019-06-06 07:02:48 +00:00
|
|
|
#endif
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
// other defines
|
|
|
|
#define UDPC_PACKET_MAX_SIZE 8192
|
|
|
|
#define UDPC_DEFAULT_PROTOCOL_ID 1357924680 // 0x50f04948
|
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
// other defines continued
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
# ifndef UDPC_LIBSODIUM_ENABLED
|
2019-12-06 11:49:30 +00:00
|
|
|
# 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
|
2019-12-04 04:08:30 +00:00
|
|
|
# endif
|
|
|
|
|
|
|
|
#endif // DOXYGEN_SHOULD_SKIP_THIS
|
2019-11-18 08:37:03 +00:00
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
#ifdef __cplusplus
|
2019-12-04 04:08:30 +00:00
|
|
|
# include <cstdint>
|
2019-06-06 07:02:48 +00:00
|
|
|
extern "C" {
|
|
|
|
#else
|
2019-12-04 04:08:30 +00:00
|
|
|
# include <stdint.h>
|
2019-06-06 07:02:48 +00:00
|
|
|
#endif
|
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
/// Opaque struct handle to Context
|
2019-08-30 03:03:26 +00:00
|
|
|
struct UDPC_Context;
|
2019-08-30 03:11:07 +00:00
|
|
|
typedef struct UDPC_Context *UDPC_HContext;
|
2019-08-30 03:03:26 +00:00
|
|
|
|
2019-12-09 12:27:58 +00:00
|
|
|
typedef enum {
|
|
|
|
UDPC_SILENT,
|
|
|
|
UDPC_ERROR,
|
|
|
|
UDPC_WARNING,
|
|
|
|
UDPC_INFO,
|
|
|
|
UDPC_VERBOSE,
|
|
|
|
UDPC_DEBUG
|
|
|
|
} UDPC_LoggingType;
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
UDPC_AUTH_POLICY_FALLBACK=0,
|
|
|
|
UDPC_AUTH_POLICY_STRICT,
|
|
|
|
UDPC_AUTH_POLICY_SIZE /// Used internally to get max size of enum
|
|
|
|
} UDPC_AuthPolicy;
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Data identifying a peer via addr, port, and scope_id
|
|
|
|
*
|
|
|
|
* This struct needn't be used directly; use UDPC_create_id(),
|
|
|
|
* UDPC_create_id_full(), UDPC_create_id_anyaddr(), or UDPC_create_id_easy() to
|
|
|
|
* create one. This struct does not hold dynamic data, so there is no need to
|
|
|
|
* free it.
|
|
|
|
*/
|
2019-09-03 03:06:46 +00:00
|
|
|
typedef struct {
|
2019-09-19 03:23:15 +00:00
|
|
|
UDPC_IPV6_ADDR_TYPE addr;
|
2019-09-18 08:35:14 +00:00
|
|
|
uint32_t scope_id;
|
2019-09-03 03:06:46 +00:00
|
|
|
uint16_t port;
|
|
|
|
} UDPC_ConnectionId;
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Data representing a received/sent packet
|
|
|
|
*/
|
2019-06-06 07:02:48 +00:00
|
|
|
typedef struct {
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* A char array of size \p UDPC_PACKET_MAX_SIZE. Note that the received data
|
|
|
|
* will probably use up less data than the full size of the array. The
|
|
|
|
* actual size of the received data is \p dataSize.
|
|
|
|
*/
|
2019-08-22 11:16:07 +00:00
|
|
|
// id is stored at offset 8, size 4 (uint32_t) even for "empty" PktInfos
|
2019-06-06 07:02:48 +00:00
|
|
|
char data[UDPC_PACKET_MAX_SIZE];
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Flags indication some additional information about the received
|
|
|
|
* packet.
|
|
|
|
*
|
|
|
|
* The following list indicates what each used bit in \p flags refers to.
|
|
|
|
* - 0x1: Is an initiate-connection packet
|
|
|
|
* - 0x2: Is a ping packet
|
|
|
|
* - 0x4: Is a packet that will not be re-sent if not received
|
|
|
|
* - 0x8: Is a packet that was re-sent
|
2019-07-25 11:51:08 +00:00
|
|
|
*/
|
|
|
|
uint32_t flags;
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief The size in bytes of the received packet's data inside the \p data
|
|
|
|
* array member variable.
|
|
|
|
*
|
|
|
|
* If this variable is zero, then this packet is invalid, or an empty packet
|
|
|
|
* was received.
|
|
|
|
*/
|
|
|
|
uint16_t dataSize;
|
2019-12-27 04:35:28 +00:00
|
|
|
uint16_t rtt;
|
2019-12-06 11:49:30 +00:00
|
|
|
/// The \p UDPC_ConnectionId of the sender
|
2019-09-03 03:06:46 +00:00
|
|
|
UDPC_ConnectionId sender;
|
2019-12-06 11:49:30 +00:00
|
|
|
/// The \p UDPC_ConnectionId of the receiver
|
2019-09-03 03:06:46 +00:00
|
|
|
UDPC_ConnectionId receiver;
|
2019-07-25 11:51:08 +00:00
|
|
|
} UDPC_PacketInfo;
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief An enum describing the type of event.
|
|
|
|
*
|
|
|
|
* Note that only the following values will be presented when using
|
|
|
|
* UDPC_get_event()
|
|
|
|
* - UDPC_ET_NONE: No events have ocurred
|
|
|
|
* - UDPC_ET_CONNECTED: A peer has initiated a connection
|
|
|
|
* - UDPC_ET_DISCONNECTED: A peer has disconnected
|
|
|
|
* - UDPC_ET_GOOD_MODE: The connection has switched to "good mode"
|
|
|
|
* - UDPC_ET_BAD_MODE: The connection has switched to "bad mode"
|
|
|
|
*
|
|
|
|
* The other unmentioned enum values are used internally, and should never be
|
|
|
|
* returned in a call to UDPC_get_event().
|
|
|
|
*/
|
2019-11-11 07:08:51 +00:00
|
|
|
typedef enum {
|
|
|
|
UDPC_ET_NONE,
|
|
|
|
UDPC_ET_REQUEST_CONNECT,
|
|
|
|
UDPC_ET_REQUEST_DISCONNECT,
|
|
|
|
UDPC_ET_CONNECTED,
|
|
|
|
UDPC_ET_DISCONNECTED,
|
|
|
|
UDPC_ET_GOOD_MODE,
|
2019-11-19 11:55:20 +00:00
|
|
|
UDPC_ET_BAD_MODE,
|
|
|
|
UDPC_ET_REQUEST_CONNECT_PK
|
2019-11-11 07:08:51 +00:00
|
|
|
} UDPC_EventType;
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief A struct containing information related to the type of event
|
|
|
|
*
|
|
|
|
* Note that instances of this struct received from a call to UDPC_get_event()
|
|
|
|
* will not store any useful data in its union member variable \p v (it will
|
|
|
|
* only be used internally).
|
|
|
|
* Thus, all events received through a call to UDPC_get_event() will contain a
|
|
|
|
* valid UDPC_ConnectionId \p conId that identifies the peer that the event is
|
|
|
|
* referring to.
|
|
|
|
*/
|
2019-11-11 07:08:51 +00:00
|
|
|
typedef struct {
|
|
|
|
UDPC_EventType type;
|
|
|
|
UDPC_ConnectionId conId;
|
2019-11-18 08:37:03 +00:00
|
|
|
union Value {
|
|
|
|
int dropAllWithAddr;
|
|
|
|
int enableLibSodium;
|
2019-11-19 11:55:20 +00:00
|
|
|
unsigned char *pk;
|
2019-11-18 08:37:03 +00:00
|
|
|
} v;
|
2019-11-11 07:08:51 +00:00
|
|
|
} UDPC_Event;
|
|
|
|
|
2019-11-27 11:26:40 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_ConnectionId with the given addr and port
|
|
|
|
*
|
|
|
|
* port should be in native byte order (not network/big-endian). This means that
|
|
|
|
* there is no need to convert the 16-bit value to network byte order, this will
|
|
|
|
* be done automatically by this library when necessary (without modifying the
|
|
|
|
* value in the used UDPC_ConnectionId).
|
|
|
|
*/
|
2019-09-19 03:23:15 +00:00
|
|
|
UDPC_ConnectionId UDPC_create_id(UDPC_IPV6_ADDR_TYPE addr, uint16_t port);
|
2019-09-03 03:06:46 +00:00
|
|
|
|
2019-11-27 11:26:40 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_ConnectionId with the given addr, scope_id, and port
|
|
|
|
*
|
|
|
|
* port should be in native byte order (not network/big-endian).
|
|
|
|
*/
|
2019-09-19 03:23:15 +00:00
|
|
|
UDPC_ConnectionId UDPC_create_id_full(UDPC_IPV6_ADDR_TYPE addr, uint32_t scope_id, uint16_t port);
|
2019-09-18 08:35:14 +00:00
|
|
|
|
2019-11-27 11:26:40 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_ConnectionId with the given port
|
|
|
|
*
|
|
|
|
* The address contained in the returned UDPC_ConnectionId will be zeroed out
|
|
|
|
* (the "anyaddr" address).
|
|
|
|
* port should be in native byte order (not network/big-endian).
|
|
|
|
*/
|
2019-09-07 07:36:11 +00:00
|
|
|
UDPC_ConnectionId UDPC_create_id_anyaddr(uint16_t port);
|
|
|
|
|
2019-11-27 11:26:40 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_ConnectionId with the given addr string and port
|
|
|
|
*
|
|
|
|
* The address string should be a valid ipv6 or ipv4 address. (If an ipv4
|
|
|
|
* address is given, the internal address of the returned UDPC_ConnectionId will
|
|
|
|
* be ipv4-mapped ipv6 address.)
|
|
|
|
* port should be in native byte order (not network/big-endian).
|
|
|
|
*/
|
2019-11-13 03:15:12 +00:00
|
|
|
UDPC_ConnectionId UDPC_create_id_easy(const char *addrString, uint16_t port);
|
|
|
|
|
2019-12-04 04:08:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_HContext that holds state for connections
|
|
|
|
*
|
|
|
|
* \param listenId The addr and port to listen on (contained in a
|
|
|
|
* UDPC_ConnectionId)
|
|
|
|
* \param isClient Whether or not this instance is a client or a server
|
|
|
|
* \param isUsingLibsodium Set to non-zero if libsodium verification of packets
|
|
|
|
* should be enabled (fails if libsodium support was not compiled)
|
|
|
|
*
|
2019-12-06 11:49:30 +00:00
|
|
|
* UDPC_is_valid_context() may be used to check if the context was successfully
|
|
|
|
* created.
|
|
|
|
*
|
|
|
|
* \warning The received UDPC_HContext must be freed with a call to UDPC_destroy().
|
2019-12-04 04:08:30 +00:00
|
|
|
*/
|
2019-11-18 08:37:03 +00:00
|
|
|
UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium);
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_HContext that holds state for connections that
|
|
|
|
* auto-updates via a thread.
|
|
|
|
*
|
|
|
|
* By default, the update interval is set to 8 milliseconds.
|
|
|
|
*
|
|
|
|
* \param listenId The addr and port to listen on (contained in a
|
|
|
|
* UDPC_ConnectionId)
|
|
|
|
* \param isClient Whether or not this instance is a client or a server
|
|
|
|
* \param isUsingLibsodium Set to non-zero if libsodium verification of packets
|
|
|
|
* should be enabled (fails if libsodium support was not compiled)
|
|
|
|
*
|
|
|
|
* UDPC_is_valid_context() may be used to check if the context was successfully
|
|
|
|
* created.
|
|
|
|
*
|
|
|
|
* \warning The received UDPC_HContext must be freed with a call to UDPC_destroy().
|
|
|
|
*/
|
2019-11-13 05:06:48 +00:00
|
|
|
UDPC_HContext UDPC_init_threaded_update(
|
|
|
|
UDPC_ConnectionId listenId,
|
2019-11-18 08:37:03 +00:00
|
|
|
int isClient,
|
|
|
|
int isUsingLibsodium);
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Creates an UDPC_HContext that holds state for connections that
|
|
|
|
* auto-updates via a thread at a specified interval.
|
|
|
|
*
|
|
|
|
* \param listenId The addr and port to listen on (contained in a
|
|
|
|
* UDPC_ConnectionId)
|
|
|
|
* \param isClient Whether or not this instance is a client or a server
|
|
|
|
* \param updateMS The interval to update at in milliseconds (clamped at a
|
|
|
|
* minimum of 4 ms and a maximum of 333 ms)
|
|
|
|
* \param isUsingLibsodium Set to non-zero if libsodium verification of packets
|
|
|
|
* should be enabled (fails if libsodium support was not compiled)
|
|
|
|
*
|
|
|
|
* UDPC_is_valid_context() may be used to check if the context was successfully
|
|
|
|
* created.
|
|
|
|
*
|
|
|
|
* \warning The received UDPC_HContext must be freed with a call to UDPC_destroy().
|
|
|
|
*/
|
2019-11-13 05:06:48 +00:00
|
|
|
UDPC_HContext UDPC_init_threaded_update_ms(
|
|
|
|
UDPC_ConnectionId listenId,
|
|
|
|
int isClient,
|
2019-11-18 08:37:03 +00:00
|
|
|
int updateMS,
|
|
|
|
int isUsingLibsodium);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Enables auto updating on a separate thread for the given UDPC_HContext
|
|
|
|
*
|
|
|
|
* By default, the update interval is set to 8 milliseconds.
|
|
|
|
*
|
|
|
|
* \param ctx The context to enable auto updating for
|
|
|
|
* \return non-zero if auto updating is enabled. If the context already had auto
|
|
|
|
* updating enabled, this function will return zero.
|
|
|
|
*/
|
2019-11-27 10:47:51 +00:00
|
|
|
int UDPC_enable_threaded_update(UDPC_HContext ctx);
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Enables auto updating on a separate thread for the given UDPC_HContext
|
|
|
|
* with the specified update interval
|
|
|
|
*
|
|
|
|
* \param ctx The context to enable auto updating for
|
|
|
|
* \param updateMS The interval to update at in milliseconds (clamped at a
|
|
|
|
* minimum of 4 ms and a maximum of 333 ms)
|
|
|
|
* \return non-zero if auto updating is enabled. If the context already had auto
|
|
|
|
* updating enabled, this function will return zero.
|
|
|
|
*/
|
2019-11-27 10:47:51 +00:00
|
|
|
int UDPC_enable_threaded_update_ms(UDPC_HContext ctx, int updateMS);
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Disables auto updating on a separate thread for the given
|
|
|
|
* UDPC_HContext
|
|
|
|
*
|
|
|
|
* \param ctx The context to disable auto updating for
|
|
|
|
* \return non-zero if auto updating is disabled. If the context already had
|
|
|
|
* auto updating disabled, this function will return zero.
|
|
|
|
*/
|
2019-11-27 10:47:51 +00:00
|
|
|
int UDPC_disable_threaded_update(UDPC_HContext ctx);
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Checks if the given UDPC_HContext is valid (successfully initialized)
|
|
|
|
*
|
|
|
|
* \return non-zero if the given context is valid
|
|
|
|
*/
|
2019-11-27 10:47:51 +00:00
|
|
|
int UDPC_is_valid_context(UDPC_HContext ctx);
|
2019-11-19 11:55:20 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Cleans up the UDPC_HContext
|
|
|
|
*
|
|
|
|
* If auto updating was enabled for the given context, it will gracefully stop
|
|
|
|
* the thread before cleaning up the context.
|
|
|
|
*
|
|
|
|
* \warning This function must be called after a UDPC_HContext is no longer used
|
|
|
|
* to avoid memory leaks.
|
|
|
|
*/
|
2019-08-30 03:03:26 +00:00
|
|
|
void UDPC_destroy(UDPC_HContext ctx);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Updates the context
|
|
|
|
*
|
|
|
|
* Updating consists of:
|
|
|
|
* - Checking if peers have timed out
|
|
|
|
* - Handling requests to connect to server peers as a client
|
|
|
|
* - Sending packets to connected peers
|
|
|
|
* - Receiving packets from connected peers
|
|
|
|
* - Calculating round-trip-time (RTT) to peers
|
|
|
|
* - Checking if a peer has not received a packet and queuing that packet to be
|
|
|
|
* resent (this is done by using an ack)
|
|
|
|
*
|
|
|
|
* If auto updating was enabled for the context, then there is no need to call
|
|
|
|
* this function.
|
|
|
|
*
|
|
|
|
* Note that the context can only receive at most one packet per call to update
|
|
|
|
* (due to the fact that UDPC created its UDP socket to not block on receive
|
|
|
|
* checks). This is why it is expected to either call this function several
|
|
|
|
* times a second (such as in a game's update loop), or have auto-updating
|
|
|
|
* enabled via UDPC_init_threaded_update(), UDPC_init_threaded_update_ms(),
|
|
|
|
* UDPC_enable_threaded_update(), or UDPC_enable_threaded_update_ms().
|
|
|
|
*/
|
2019-08-30 03:03:26 +00:00
|
|
|
void UDPC_update(UDPC_HContext ctx);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Initiate a connection to a server peer
|
|
|
|
*
|
|
|
|
* Note that this function does nothing on a server context.
|
|
|
|
*
|
|
|
|
* \param ctx The context to initiate a connection from
|
|
|
|
* \param connectionId The server peer to initiate a connection to
|
|
|
|
* \param enableLibSodium If packet headers should be verified with the server
|
|
|
|
* peer (Fails if UDPC was not compiled with libsodium support)
|
|
|
|
*/
|
2019-11-19 11:55:20 +00:00
|
|
|
void UDPC_client_initiate_connection(
|
|
|
|
UDPC_HContext ctx,
|
|
|
|
UDPC_ConnectionId connectionId,
|
|
|
|
int enableLibSodium);
|
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Initiate a connection to a server peer with an expected public key
|
|
|
|
*
|
|
|
|
* Note that this function does nothing on a server context.
|
|
|
|
*
|
|
|
|
* \param ctx The context to initiate a connection from
|
|
|
|
* \param connectionId The server peer to initiate a connection to
|
|
|
|
* \param serverPK A pointer to the public key that the server is expected to
|
|
|
|
* use (if the server does not use this public key, then the connection will
|
|
|
|
* fail; it must point to a buffer of size \p crypto_sign_PUBLICKEYBYTES)
|
|
|
|
*
|
|
|
|
* This function assumes that support for libsodium was enabled when UDPC was
|
|
|
|
* compiled. If it has not, then this function will fail.
|
|
|
|
*/
|
2019-11-19 11:55:20 +00:00
|
|
|
void UDPC_client_initiate_connection_pk(
|
|
|
|
UDPC_HContext ctx,
|
|
|
|
UDPC_ConnectionId connectionId,
|
|
|
|
unsigned char *serverPK);
|
2019-08-29 02:07:24 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Queues a packet to be sent to the specified peer
|
|
|
|
*
|
2019-12-22 13:50:50 +00:00
|
|
|
* Note that there must already be an established connection with the peer. If
|
|
|
|
* a packet is queued for a peer that is not connected, it will be dropped and
|
|
|
|
* logged with log-level warning. A client can establish a connection to a
|
|
|
|
* server peer via a call to UDPC_client_initiate_connection() or
|
|
|
|
* UDPC_client_initiate_connection_pk(). A server must receive an
|
|
|
|
* initiate-connection-packet from a client to establish a connection (sent by
|
|
|
|
* previously mentioned UDPC_client_initiate_* functions).
|
2019-12-06 11:49:30 +00:00
|
|
|
*
|
|
|
|
* \param ctx The context to send a packet on
|
|
|
|
* \param destinationId The peer to send a packet to
|
|
|
|
* \param isChecked Set to non-zero if the packet should be re-sent if the peer
|
|
|
|
* doesn't receive it
|
|
|
|
* \param data A pointer to data to be sent in a packet
|
|
|
|
* \param size The size in bytes of the data to be sent
|
|
|
|
*/
|
2019-09-07 07:36:11 +00:00
|
|
|
void UDPC_queue_send(UDPC_HContext ctx, UDPC_ConnectionId destinationId,
|
2019-09-20 05:01:26 +00:00
|
|
|
int isChecked, void *data, uint32_t size);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-12-06 11:49:30 +00:00
|
|
|
/*!
|
|
|
|
* \brief Gets the size of the data structure holding queued packets
|
|
|
|
*
|
|
|
|
* Note that a UDPC context holds a different data structure per established
|
|
|
|
* connection that holds a limited amount of packets to send. If a connection's
|
|
|
|
* queue is full, it will not be removed from the main queue that this function
|
|
|
|
* (and UDPC_queue_send()) uses. The queue that this function refers to does not
|
|
|
|
* have an imposed limit as it is implemented as a thread-safe linked list (data
|
2019-12-22 13:50:50 +00:00
|
|
|
* is dynamically stored on the heap) and access to this data structure is
|
|
|
|
* faster than accessing a connection's internal queue. Also note that this
|
|
|
|
* queue holds packets for all connections this context maintains. Thus if one
|
|
|
|
* connection has free space, then it may partially remove packets only destined
|
|
|
|
* for that connection from the queue this function refers to.
|
2019-12-06 11:49:30 +00:00
|
|
|
*/
|
2019-11-06 05:35:16 +00:00
|
|
|
unsigned long UDPC_get_queue_send_current_size(UDPC_HContext ctx);
|
|
|
|
|
2019-12-22 13:50:50 +00:00
|
|
|
/*!
|
|
|
|
* \brief Gets the size of a connection's queue of queued packets
|
|
|
|
*
|
|
|
|
* Note that a UDPC context holds a queue per established connection that holds
|
|
|
|
* a limited amount of packets to send. This function checks a connection's
|
|
|
|
* internal queue, but must do so after locking an internal mutex (a call to
|
|
|
|
* UDPC_update() will lock this mutex, regardless of whether or not the context
|
|
|
|
* is using threaded update).
|
|
|
|
*/
|
2019-12-18 04:47:46 +00:00
|
|
|
unsigned long UDPC_get_queued_size(UDPC_HContext ctx, UDPC_ConnectionId id, int *exists);
|
|
|
|
|
2019-12-22 13:50:50 +00:00
|
|
|
/*!
|
|
|
|
* \brief Gets the size limit of a connection's queue of queued packets
|
|
|
|
*
|
|
|
|
* Note that a call to this function does not use any locks, as the limit is
|
|
|
|
* known at compile time and is the same for all UDPC connections.
|
|
|
|
*/
|
2019-12-18 04:47:46 +00:00
|
|
|
unsigned long UDPC_get_max_queued_size();
|
|
|
|
|
2019-08-30 03:03:26 +00:00
|
|
|
int UDPC_set_accept_new_connections(UDPC_HContext ctx, int isAccepting);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-11-11 07:08:51 +00:00
|
|
|
void UDPC_drop_connection(UDPC_HContext ctx, UDPC_ConnectionId connectionId, int dropAllWithAddr);
|
2019-08-28 07:38:14 +00:00
|
|
|
|
2019-09-17 11:33:47 +00:00
|
|
|
int UDPC_has_connection(UDPC_HContext ctx, UDPC_ConnectionId connectionId);
|
|
|
|
|
2019-09-20 05:01:26 +00:00
|
|
|
UDPC_ConnectionId* UDPC_get_list_connected(UDPC_HContext ctx, unsigned int *size);
|
|
|
|
|
|
|
|
void UDPC_free_list_connected(UDPC_ConnectionId *list);
|
|
|
|
|
2019-11-11 07:08:51 +00:00
|
|
|
uint32_t UDPC_get_protocol_id(UDPC_HContext ctx);
|
|
|
|
|
2019-08-30 03:03:26 +00:00
|
|
|
uint32_t UDPC_set_protocol_id(UDPC_HContext ctx, uint32_t id);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-11-11 07:08:51 +00:00
|
|
|
UDPC_LoggingType UDPC_get_logging_type(UDPC_HContext ctx);
|
|
|
|
|
2019-09-17 11:33:47 +00:00
|
|
|
UDPC_LoggingType UDPC_set_logging_type(UDPC_HContext ctx, UDPC_LoggingType loggingType);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-11-11 07:08:51 +00:00
|
|
|
int UPDC_get_receiving_events(UDPC_HContext ctx);
|
|
|
|
|
|
|
|
int UDPC_set_receiving_events(UDPC_HContext ctx, int isReceivingEvents);
|
|
|
|
|
|
|
|
UDPC_Event UDPC_get_event(UDPC_HContext ctx, unsigned long *remaining);
|
|
|
|
|
2019-11-06 05:35:16 +00:00
|
|
|
UDPC_PacketInfo UDPC_get_received(UDPC_HContext ctx, unsigned long *remaining);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-11-27 10:41:38 +00:00
|
|
|
int UDPC_set_libsodium_keys(UDPC_HContext ctx, unsigned char *sk, unsigned char *pk);
|
|
|
|
|
|
|
|
int UDPC_set_libsodium_key_easy(UDPC_HContext ctx, unsigned char *sk);
|
2019-11-19 11:55:20 +00:00
|
|
|
|
2019-11-27 11:12:57 +00:00
|
|
|
int UDPC_unset_libsodium_keys(UDPC_HContext ctx);
|
2019-11-21 03:23:40 +00:00
|
|
|
|
2019-12-09 12:27:58 +00:00
|
|
|
int UDPC_get_auth_policy(UDPC_HContext ctx);
|
|
|
|
int UDPC_set_auth_policy(UDPC_HContext ctx, int value);
|
|
|
|
|
2019-09-18 08:35:14 +00:00
|
|
|
const char *UDPC_atostr_cid(UDPC_HContext ctx, UDPC_ConnectionId connectionId);
|
|
|
|
|
2019-09-19 03:23:15 +00:00
|
|
|
const char *UDPC_atostr(UDPC_HContext ctx, UDPC_IPV6_ADDR_TYPE addr);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-09-17 08:17:16 +00:00
|
|
|
/// addrStr must be a valid ipv6 address or a valid ipv4 address
|
2019-09-19 03:23:15 +00:00
|
|
|
UDPC_IPV6_ADDR_TYPE UDPC_strtoa(const char *addrStr);
|
2019-06-06 07:02:48 +00:00
|
|
|
|
2019-09-19 03:23:15 +00:00
|
|
|
UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(const char *addrStr, uint32_t *linkId_out);
|
2019-09-18 08:35:14 +00:00
|
|
|
|
2019-06-06 07:02:48 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif
|