Packet acknowledgement system for UDP
If this library helps you, please support it: Become a supporter
reliable is a simple packet acknowledgement system for UDP-based protocols.
It's useful in situations where you need to know which UDP packets you sent were received by the other side.
It has the following features:
reliable is stable and production ready.
Reliable is designed to operate with your own network socket library.
If you don't have one already, try netcode, it's designed to work well with reliable.
First, create an endpoint on each side of the connection:
struct reliable_config_t config;
reliable_default_config( &config );
config.max_packet_size = 32 * 1024;
config.fragment_above = 1200;
config.max_fragments = 32;
config.fragment_size = 1024;
config.transmit_packet_function = transmit_packet;
config.process_packet_function = process_packet;
reliable_endpoint_t * endpoint = reliable_endpoint_create( &config, time );
if ( endpoint == NULL )
{
printf( "error: could not create endpoint\n" );
exit(1);
}reliable_endpoint_create returns NULL, in debug and release alike, if the config is not
valid or if an allocation fails, and it frees everything it took before it does. Check the
result.
For example, in a client/server setup you would have one endpoint on each client, and n endpoints on the server, one for each client slot.
Next, create a function to transmit packets:
static void transmit_packet( void * context, uint64_t id, uint16_t sequence, uint8_t * packet_data, int packet_bytes )
{
// send packet using your own udp socket
}And a function to process received packets:
static int process_packet( void * context, uint64_t id, uint16_t sequence, uint8_t * packet_data, int packet_bytes )
{
// read the packet here and process its contents, return 0 if the packet should not be acked
return 1;
}For each packet you receive from your udp socket, call this on the endpoint that should receive it:
reliable_endpoint_receive_packet( endpoint, packet_data, packet_bytes );Now you can send packets through the endpoint:
reliable_endpoint_send_packet( endpoint, packet_data, packet_bytes );And get acks like this:
int num_acks;
const uint16_t * acks = reliable_endpoint_get_acks( endpoint, &num_acks );
for ( int i = 0; i reliable - Glenn Fiedler and Rowan Claude
The license doesn't require this. It's an official request, and honoring it is appreciated. Fair credit keeps open source honest.No open issues yet, or sync has not completed.