NET_GetAddressStatus - Man Page

Check if an address is resolved, without blocking.

Synopsis

#include <SDL3_net/SDL_net.h>

NET_Status NET_GetAddressStatus(NET_Address *address);

Description

The NET_Address objects returned by NET_ResolveHostname take time to do their work, so it does so _asynchronously_ instead of making your program wait an indefinite amount of time.

This function allows you to check the progress of that work without blocking.

Resolution can fail after some time (DNS server took awhile to reply that the hostname isn't recognized, etc), so be sure to check the result of this function instead of assuming it worked because it's non-zero!

Once an address is successfully resolved, it can be used to connect to the host represented by the address.

Function Parameters

address

The NET_Address to query.

Return Value

Returns NET_SUCCESS if successfully resolved, NET_FAILURE if resolution failed, NET_WAITING if still resolving (this function timed out without resolution); if NET_FAILURE, call SDL_GetError() for details.

Thread Safety

It is safe to call this function from any thread.

Availability

This function is available since SDL_net 3.0.0.

See Also

NET_WaitUntilResolved(3)

Referenced By

NET_GetAddressBytes(3), NET_GetAddressString(3), NET_ResolveHostname(3), NET_WaitUntilResolved(3).

SDL_net 3.2.0 SDL_net3 FUNCTIONS