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

SDLNet_GetAddressStatus

Check if an address is resolved, without blocking.

Header File

Defined in <SDL3_net/SDL_net.h>

Syntax

int SDLNet_GetAddressStatus(SDLNet_Address *address);

Function Parameters

SDLNet_Address * address The SDLNet_Address to query.

Return Value

(int) Returns 1 if successfully resolved, -1 if resolution failed, 0 if still resolving; if -1, call SDL_GetError() for details.

Remarks

The SDLNet_Address objects returned by SDLNet_ResolveHostname take time to do their work, so it is 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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_Net 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

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