Merge commit '47ad96e2b6c5704872b3615a160cd78d29b46b21' toxcore v0.2.19

This commit is contained in:
2024-03-28 16:13:51 +01:00
23 changed files with 1072 additions and 578 deletions

View File

@ -712,7 +712,8 @@ static int tox_load(Tox *tox, const uint8_t *data, uint32_t length)
length - cookie_len, STATE_COOKIE_TYPE);
}
Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error)
nullable(1, 2, 3)
static Tox *tox_new_system(const struct Tox_Options *options, Tox_Err_New *error, const Tox_System *sys)
{
struct Tox_Options *default_options = nullptr;
@ -736,7 +737,6 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error)
const struct Tox_Options *const opts = options != nullptr ? options : default_options;
assert(opts != nullptr);
const Tox_System *sys = tox_options_get_operating_system(opts);
const Tox_System default_system = tox_default_system();
if (sys == nullptr) {
@ -1020,6 +1020,37 @@ Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error)
return tox;
}
Tox *tox_new(const struct Tox_Options *options, Tox_Err_New *error)
{
return tox_new_system(options, error, nullptr);
}
Tox *tox_new_testing(const Tox_Options *options, Tox_Err_New *error, const Tox_Options_Testing *testing, Tox_Err_New_Testing *testing_error)
{
if (testing == nullptr) {
SET_ERROR_PARAMETER(error, TOX_ERR_NEW_NULL);
SET_ERROR_PARAMETER(testing_error, TOX_ERR_NEW_TESTING_NULL);
return nullptr;
}
if (testing->operating_system == nullptr) {
SET_ERROR_PARAMETER(error, TOX_ERR_NEW_NULL);
SET_ERROR_PARAMETER(testing_error, TOX_ERR_NEW_TESTING_NULL);
return nullptr;
}
const Tox_System *sys = testing->operating_system;
if (sys->rng == nullptr || sys->ns == nullptr || sys->mem == nullptr) {
SET_ERROR_PARAMETER(error, TOX_ERR_NEW_NULL);
SET_ERROR_PARAMETER(testing_error, TOX_ERR_NEW_TESTING_NULL);
return nullptr;
}
SET_ERROR_PARAMETER(testing_error, TOX_ERR_NEW_TESTING_OK);
return tox_new_system(options, error, sys);
}
void tox_kill(Tox *tox)
{
if (tox == nullptr) {
@ -4269,7 +4300,7 @@ uint32_t tox_group_invite_accept(Tox *tox, uint32_t friend_number, const uint8_t
}
case -6: {
SET_ERROR_PARAMETER(error, TOX_ERR_GROUP_INVITE_ACCEPT_CORE);
SET_ERROR_PARAMETER(error, TOX_ERR_GROUP_INVITE_ACCEPT_FRIEND_NOT_FOUND);
return UINT32_MAX;
}

File diff suppressed because it is too large Load Diff

View File

@ -265,14 +265,6 @@ void tox_options_set_experimental_thread_safety(
{
options->experimental_thread_safety = experimental_thread_safety;
}
const Tox_System *tox_options_get_operating_system(const Tox_Options *options)
{
return options->operating_system;
}
void tox_options_set_operating_system(Tox_Options *options, const Tox_System *operating_system)
{
options->operating_system = operating_system;
}
bool tox_options_get_experimental_groups_persistence(const Tox_Options *options)
{
return options->experimental_groups_persistence;
@ -1451,8 +1443,8 @@ const char *tox_err_group_invite_accept_to_string(Tox_Err_Group_Invite_Accept va
case TOX_ERR_GROUP_INVITE_ACCEPT_PASSWORD:
return "TOX_ERR_GROUP_INVITE_ACCEPT_PASSWORD";
case TOX_ERR_GROUP_INVITE_ACCEPT_CORE:
return "TOX_ERR_GROUP_INVITE_ACCEPT_CORE";
case TOX_ERR_GROUP_INVITE_ACCEPT_FRIEND_NOT_FOUND:
return "TOX_ERR_GROUP_INVITE_ACCEPT_FRIEND_NOT_FOUND";
case TOX_ERR_GROUP_INVITE_ACCEPT_FAIL_SEND:
return "TOX_ERR_GROUP_INVITE_ACCEPT_FAIL_SEND";

View File

@ -2,6 +2,13 @@
* Copyright © 2022 The TokTok team.
*/
/**
* WARNING: This is an experimental API and is subject to change.
*
* At this point, it probably won't change very much anymore, but we may have
* small breaking changes before a stable release.
*/
#ifndef C_TOXCORE_TOXCORE_TOX_DISPATCH_H
#define C_TOXCORE_TOXCORE_TOX_DISPATCH_H

View File

@ -2,6 +2,13 @@
* Copyright © 2022-2024 The TokTok team.
*/
/**
* WARNING: This is an experimental API and is subject to change.
*
* At this point, it probably won't change very much anymore, but we may have
* small breaking changes before a stable release.
*/
#ifndef C_TOXCORE_TOXCORE_TOX_EVENTS_H
#define C_TOXCORE_TOXCORE_TOX_EVENTS_H
@ -570,6 +577,8 @@ void tox_events_free(Tox_Events *events);
uint32_t tox_events_bytes_size(const Tox_Events *events);
bool tox_events_get_bytes(const Tox_Events *events, uint8_t *bytes);
typedef struct Tox_System Tox_System;
Tox_Events *tox_events_load(const Tox_System *sys, const uint8_t *bytes, uint32_t bytes_size);
bool tox_events_equal(const Tox_System *sys, const Tox_Events *a, const Tox_Events *b);

View File

@ -1,5 +1,5 @@
/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2016-2020 The TokTok team.
* Copyright © 2016-2024 The TokTok team.
* Copyright © 2013 Tox project.
*/
@ -18,38 +18,49 @@ extern "C" {
typedef uint64_t tox_mono_time_cb(void *user_data);
struct Tox_System {
typedef struct Tox_System {
tox_mono_time_cb *mono_time_callback;
void *mono_time_user_data;
const struct Random *rng;
const struct Network *ns;
const struct Memory *mem;
};
} Tox_System;
Tox_System tox_default_system(void);
const Tox_System *tox_get_system(Tox *tox);
typedef struct Tox_Options_Testing {
const struct Tox_System *operating_system;
} Tox_Options_Testing;
typedef enum Tox_Err_New_Testing {
TOX_ERR_NEW_TESTING_OK,
TOX_ERR_NEW_TESTING_NULL,
} Tox_Err_New_Testing;
Tox *tox_new_testing(const Tox_Options *options, Tox_Err_New *error, const Tox_Options_Testing *testing, Tox_Err_New_Testing *testing_error);
void tox_lock(const Tox *tox);
void tox_unlock(const Tox *tox);
const Tox_System *tox_get_system(Tox *tox);
/**
* Set the callback for the `friend_lossy_packet` event for a specific packet ID.
* Pass NULL to unset.
* Set the callback for the `friend_lossy_packet` event for a specific packet
* ID. Pass NULL to unset.
*
* allowed packet ID range:
* from `PACKET_ID_RANGE_LOSSY_START` to `PACKET_ID_RANGE_LOSSY_END` (both inclusive)
* from `PACKET_ID_RANGE_LOSSY_START` to `PACKET_ID_RANGE_LOSSY_END` (both
* inclusive)
*/
void tox_callback_friend_lossy_packet_per_pktid(Tox *tox, tox_friend_lossy_packet_cb *callback, uint8_t pktid);
/**
* Set the callback for the `friend_lossless_packet` event for a specific packet ID.
* Pass NULL to unset.
* Set the callback for the `friend_lossless_packet` event for a specific packet
* ID. Pass NULL to unset.
*
* allowed packet ID range:
* from `PACKET_ID_RANGE_LOSSLESS_CUSTOM_START` to `PACKET_ID_RANGE_LOSSLESS_CUSTOM_END` (both inclusive)
* and
* `PACKET_ID_MSI`
* from `PACKET_ID_RANGE_LOSSLESS_CUSTOM_START` to
* `PACKET_ID_RANGE_LOSSLESS_CUSTOM_END` (both inclusive) and `PACKET_ID_MSI`
*/
void tox_callback_friend_lossless_packet_per_pktid(Tox *tox, tox_friend_lossless_packet_cb *callback, uint8_t pktid);
@ -78,7 +89,7 @@ uint32_t tox_dht_node_public_key_size(void);
/**
* @param public_key The node's public key.
* @param ip The node's IP address, represented as a null terminated string.
* @param ip The node's IP address, represented as a NUL-terminated C string.
* @param port The node's port.
*/
typedef void tox_dht_get_nodes_response_cb(Tox *tox, const uint8_t *public_key, const char *ip, uint16_t port,
@ -98,7 +109,8 @@ typedef enum Tox_Err_Dht_Get_Nodes {
TOX_ERR_DHT_GET_NODES_OK,
/**
* UDP is disabled in tox options; the DHT can only be queried when UDP is enabled.
* UDP is disabled in Tox options; the DHT can only be queried when UDP is
* enabled.
*/
TOX_ERR_DHT_GET_NODES_UDP_DISABLED,
@ -118,21 +130,24 @@ typedef enum Tox_Err_Dht_Get_Nodes {
TOX_ERR_DHT_GET_NODES_BAD_IP,
/**
* The getnodes request failed. This usually means the packet failed to send.
* The getnodes request failed. This usually means the packet failed to
* send.
*/
TOX_ERR_DHT_GET_NODES_FAIL,
} Tox_Err_Dht_Get_Nodes;
/**
* This function sends a getnodes request to a DHT node for its peers that
* are "close" to the passed target public key according to the distance metric used
* by the DHT implementation.
* are "close" to the passed target public key according to the distance metric
* used by the DHT implementation.
*
* @param public_key The public key of the node that we wish to query. This key must be
* at least `TOX_DHT_NODE_PUBLIC_KEY_SIZE` bytes in length.
* @param ip A NULL terminated string representing the IP address of the node we wish to query.
* @param public_key The public key of the node that we wish to query. This key
* must be at least `TOX_DHT_NODE_PUBLIC_KEY_SIZE` bytes in length.
* @param ip A NUL-terminated C string representing the IP address of the node
* we wish to query.
* @param port The port of the node we wish to query.
* @param target_public_key The public key for which we want to find close nodes.
* @param target_public_key The public key for which we want to find close
* nodes.
*
* @return true on success.
*/
@ -140,8 +155,9 @@ bool tox_dht_get_nodes(const Tox *tox, const uint8_t *public_key, const char *ip
const uint8_t *target_public_key, Tox_Err_Dht_Get_Nodes *error);
/**
* This function returns the ratio of close dht nodes that are known to support announce/store.
* This function returns the number of DHT nodes in the closelist.
* This function returns the ratio of close dht nodes that are known to support
* announce/store. This function returns the number of DHT nodes in the
* closelist.
*
* @return number
*/
@ -149,7 +165,7 @@ uint16_t tox_dht_get_num_closelist(const Tox *tox);
/**
* This function returns the number of DHT nodes in the closelist,
* that are capable to store annouce data (introduced in version 0.2.18).
* that are capable to store announce data (introduced in version 0.2.18).
*
* @return number
*/
@ -169,30 +185,32 @@ uint16_t tox_dht_get_num_closelist_announce_capable(const Tox *tox);
uint32_t tox_group_peer_ip_string_max_length(void);
/**
* Return the length of the peer's IP address in string form. If the group number or ID
* is invalid, the return value is unspecified.
* Return the length of the peer's IP address in string form. If the group
* number or ID is invalid, the return value is unspecified.
*
* @param group_number The group number of the group we wish to query.
* @param peer_id The ID of the peer whose IP address length we want to retrieve.
* @param peer_id The ID of the peer whose IP address length we want to
* retrieve.
*/
size_t tox_group_peer_get_ip_address_size(const Tox *tox, uint32_t group_number, uint32_t peer_id,
Tox_Err_Group_Peer_Query *error);
/**
* Write the IP address associated with the designated peer_id for the designated group number
* to ip_addr.
* Write the IP address associated with the designated peer_id for the
* designated group number to ip_addr.
*
* If the peer is forcing TCP connections a placeholder value will be written instead,
* indicating that their real IP address is unknown to us.
* If the peer is forcing TCP connections a placeholder value will be written
* instead, indicating that their real IP address is unknown to us.
*
* If `peer_id` designates ourself, it will write either our own IP address or a placeholder value,
* depending on whether or not we're forcing TCP connections.
* If `peer_id` designates ourself, it will write either our own IP address or a
* placeholder value, depending on whether or not we're forcing TCP connections.
*
* Call tox_group_peer_get_ip_address_size to determine the allocation size for the `ip_addr` parameter.
* Call tox_group_peer_get_ip_address_size to determine the allocation size for
* the `ip_addr` parameter.
*
* @param group_number The group number of the group we wish to query.
* @param peer_id The ID of the peer whose public key we wish to retrieve.
* @param ip_addr A valid memory region large enough to store the IP address string.
* If this parameter is NULL, this function call has no effect.
* @param ip_addr A valid memory region large enough to store the IP address
* string. If this parameter is NULL, this function call has no effect.
*
* @return true on success.
*/