NET_GetLocalAddresses - Man Page

#include <SDL3_net/SDL_net.h>

extern SDL_DECLSPEC NET_Address **SDLCALL NET_GetLocalAddresses(int *num_addresses);

This returns addresses that you can theoretically bind a socket to, to accept connections from other machines at that address.

You almost never need this function; first, it's hard to tell _what_ is a good address to bind to, without asking the user (who will likely find it equally hard to decide). Second, most machines will have lots of _private_ addresses that are accessible on the same LAN, but not public ones that are accessible from the outside Internet.

Usually it's better to use NET_CreateServer() or NET_CreateDatagramSocket() with a NULL address, to say "bind to all interfaces."

The array of addresses returned from this is guaranteed to be NULL-terminated. You can also pass a pointer to an int, which will return the final count, not counting the NULL at the end of the array.

Pass the returned array to NET_FreeLocalAddresses when you are done with it. It is safe to keep any addresses you want from this array even after calling that function, as long as you called NET_RefAddress() on them.

num_addresses

on exit, will be set to the number of addresses returned. Can be NULL.

Returns A NULL-terminated array of NET_Address pointers, one for each bindable address on the system, or NULL on error; call SDL_GetError() for details.

It is safe to call this function from any thread.

This function is available since SDL_net 3.0.0.

NET_Address.3type(3), NET_CreateDatagramSocket(3), NET_CreateServer(3).