NET_DestroyDatagram - Man Page

Dispose of a datagram packet previously received.

Synopsis

#include <SDL3_net/SDL_net.h>

void NET_DestroyDatagram(NET_Datagram *dgram);

Description

You must pass packets received through NET_ReceiveDatagram to this function when you are done with them. This will free resources used by this packet and unref its NET_Address.

If you want to save the sender's address from the packet past this time, it is safe to call NET_RefAddress() on the address and hold onto its pointer, so long as you call NET_UnrefAddress() on it when you are done with it.

Once you call this function, the datagram pointer becomes invalid and should not be used again by the app.

Function Parameters

dgram

the datagram packet to destroy.

Thread Safety

It is safe to call this function from any thread.

Availability

This function is available since SDL_net 3.0.0.

Referenced By

NET_Datagram.3type(3), NET_ReceiveDatagram(3).

SDL_net 3.2.0 SDL_net3 FUNCTIONS