(This function is part of SDL_net, a separate library from SDL.)

NET_DestroyDatagram

Dispose of a datagram packet previously received.

Header File

Defined in <SDL3_net/SDL_net.h>

Syntax

void NET_DestroyDatagram(NET_Datagram *dgram);

Function Parameters

NET_Datagram *

dgram

the datagram packet to destroy.

Remarks

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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_net 3.0.0.

---

CategoryAPI, CategoryAPIFunction, CategorySDLNet

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.