Files
tomato/testing/support/public/tox_network.hh
Green Sky 9b36dd9d99 Squashed 'external/toxcore/c-toxcore/' changes from c9cdae001..9ed2fa80d
9ed2fa80d fix(toxav): remove extra copy of video frame on encode
de30cf3ad docs: Add new file kinds, that should be useful to all clients.
d5b5e879d fix(DHT): Correct node skipping logic timed out nodes.
30e71fe97 refactor: Generate event dispatch functions and add tox_events_dispatch.
8fdbb0b50 style: Format parameter lists in event handlers.
d00dee12b refactor: Add warning logs when losing chat invites.
b144e8db1 feat: Add a way to look up a file number by ID.
849281ea0 feat: Add a way to fetch groups by chat ID.
a2c177396 refactor: Harden event system and improve type safety.
8f5caa656 refactor: Add MessagePack string support to bin_pack.
34e8d5ad5 chore: Add GitHub CodeQL workflow and local Docker runner.
f7b068010 refactor: Add nullability annotations to event headers.
788abe651 refactor(toxav): Use system allocator for mutexes.
2e4b423eb refactor: Use specific typedefs for public API arrays.
2baf34775 docs(toxav): update idle iteration interval see 679444751876fa3882a717772918ebdc8f083354
2f87ac67b feat: Add Event Loop abstraction (Ev).
f8dfc38d8 test: Fix data race in ToxScenario virtual_clock.
38313921e test(TCP): Add regression test for TCP priority queue integrity.
f94a50d9a refactor(toxav): Replace mutable_mutex with dynamically allocated mutex.
ad054511e refactor: Internalize DHT structs and add debug helpers.
8b467cc96 fix: Prevent potential integer overflow in group chat handshake.
4962bdbb8 test: Improve TCP simulation and add tests
5f0227093 refactor: Allow nullable data in group chat handlers.
e97b18ea9 chore: Improve Windows Docker support.
b14943bbd refactor: Move Logger out of Messenger into Tox.
dd3136250 cleanup: Apply nullability qualifiers to C++ codebase.
1849f70fc refactor: Extract low-level networking code to net and os_network.
8fec75421 refactor: Delete tox_random, align on rng and os_random.
a03ae8051 refactor: Delete tox_memory, align on mem and os_memory.
4c88fed2c refactor: Use `std::` prefixes more consistently in C++ code.
72452f2ae test: Add some more tests for onion and shared key cache.
d5a51b09a cleanup: Use tox_attributes.h in tox_private.h and install it.
b6f5b9fc5 test: Add some benchmarks for various high level things.
8a8d02785 test(support): Introduce threaded Tox runner and simulation barrier
d68d1d095 perf(toxav): optimize audio and video intermediate buffers by keeping them around
REVERT: c9cdae001 fix(toxav): remove extra copy of video frame on encode

git-subtree-dir: external/toxcore/c-toxcore
git-subtree-split: 9ed2fa80d582c714d6bdde6a7648220a92cddff8
2026-02-01 14:26:52 +01:00

88 lines
3.1 KiB
C++

/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2026 The TokTok team.
*/
#ifndef C_TOXCORE_TESTING_SUPPORT_TOX_NETWORK_H
#define C_TOXCORE_TESTING_SUPPORT_TOX_NETWORK_H
#include <memory>
#include <utility>
#include <vector>
#include "../../../toxcore/attributes.h"
#include "simulation.hh"
#include "tox_runner.hh"
namespace tox::test {
struct ConnectedFriend {
std::unique_ptr<SimulatedNode> node;
std::unique_ptr<ToxRunner> runner;
uint32_t friend_number;
ConnectedFriend(std::unique_ptr<SimulatedNode> node_in, std::unique_ptr<ToxRunner> runner_in,
uint32_t friend_number_in)
: node(std::move(node_in))
, runner(std::move(runner_in))
, friend_number(friend_number_in)
{
}
ConnectedFriend(ConnectedFriend &&) = default;
ConnectedFriend &operator=(ConnectedFriend &&) = default;
~ConnectedFriend();
};
/**
* @brief Sets up a network of connected Tox instances.
*
* This function creates num_friends Tox instances, adds them as friends to main_tox,
* and bootstraps them to main_node. It then runs the simulation until all friends
* are connected to main_tox.
*
* @param sim The simulation to run.
* @param main_tox The main Tox instance to which friends will connect.
* @param main_node The simulated node hosting the main Tox instance.
* @param num_friends The number of friends to create and connect.
* @param options Optional Tox_Options to use for the friend Tox instances.
* @return A vector of ConnectedFriend structures, each representing a friend.
*/
std::vector<ConnectedFriend> setup_connected_friends(Simulation &sim, Tox *_Nonnull main_tox,
SimulatedNode &main_node, int num_friends, const Tox_Options *_Nullable options = nullptr,
bool verbose = false);
/**
* @brief Connects two existing Tox instances as friends.
*
* This function adds each Tox instance as a friend to the other, bootstraps
* them to each other, and runs the simulation until they are connected.
*
* @param sim The simulation to run.
* @param node1 The simulated node hosting the first Tox instance.
* @param tox1 The first Tox instance.
* @param node2 The simulated node hosting the second Tox instance.
* @param tox2 The second Tox instance.
* @return True if connected successfully, false otherwise.
*/
bool connect_friends(Simulation &sim, SimulatedNode &node1, Tox *_Nonnull tox1,
SimulatedNode &node2, Tox *_Nonnull tox2);
/**
* @brief Sets up a group and has all friends join it.
*
* This function creates a new public group on main_tox, invites all friends in the
* provided vector, and runs the simulation until all friends have joined and
* main_tox sees all of them.
*
* @param sim The simulation to run.
* @param main_tox The main Tox instance that creates the group.
* @param friends The friends to invite to the group.
* @return The group number on the main Tox instance, or UINT32_MAX on failure.
*/
uint32_t setup_connected_group(
Simulation &sim, Tox *_Nonnull main_tox, const std::vector<ConnectedFriend> &friends);
} // namespace tox::test
#endif // C_TOXCORE_TESTING_SUPPORT_TOX_NETWORK_H