NET_AcceptClient(3)

📦
version 3.2.0 · 2 versions
, in fedora 43, fedora 44

✨ NET_AcceptClient(3) ✨

okay bestie, welcome to the SDL_net3 manual, page NET_AcceptClient 💖 this is where your server finally stops ghosting all the clients knocking on its door.

🌸 NAME 🌸

NET_AcceptClient — create a stream socket for the next pending client connection. it's giving "yes queen, come in" 💅

🎀 SYNOPSIS 🎀

#include <SDL3_net/SDL_net.h>

bool NET_AcceptClient(NET_Server *server, NET_StreamSocket **client_stream);

🦋 DESCRIPTION 🦋

so here's the tea, fr fr: when a client connects to a server, their connection just... sits there. pending. waiting. 🙈 It stays pending until the server accepts the connection. Once it's accepted, the server gets handed a stream socket to talk to that client with, and from then on they can send data to each other and receive data from each other. mutuals!! 🫶

unlike NET_CreateClient, the stream sockets you get back from this function are already connected — you do NOT have to sit around waiting for the connection to finish, because server acceptance is literally the final step of connecting. no loading screen, no vibe check pending, it's done. ✨

This function does not block. So if there are no new connections pending, it will return true (for success, but *client_stream will be set to NULL. That is not an error — it's a super common condition that your app should expect. In fact, you should call this function in a loop until that condition happens, so that all the pending connections get accepted in a single batch. one sweep, all the besties. 👑

If you do want the server to sleep until there's a new connection, you can use NET_WaitUntilInputAvailable(). 😴

When you're done with the newly-accepted client, you can disconnect and dispose of the stream socket by calling NET_DestroyStreamSocket(). bye babe 💜

💅 FUNCTION PARAMETERS 💅

  • server — the server object to check for pending connections. this is the one doing the vibe check.
  • client_stream — Will be set to a new stream socket if a connection was pending, NULL otherwise.

🔥 RETURN VALUE 🔥

Returns true on success (even if no new connections were pending), false on error; call SDL_GetError() for details. yes, even "nothing happened" counts as success, that's just how she is.

🌈 THREAD SAFETY 🌈

You should not operate on the same server from multiple threads at the same time without supplying a serialization mechanism. no cap, that's a one-bestie-at-a-time situation. 🚫

However — different threads may access different servers at the same time without problems. everybody gets their own, slay. 🎀

⭐ AVAILABILITY ⭐

This function is available since SDL_net 3.0.0.

👑 SEE ALSO 👑

and that's the whole page, babe 🧚 this was SDL_net manual, version SDL_net 3.2.0, page NET_AcceptClient(3) — go accept some clients, you're literally the main character of this server 💖✨🌸

📦 where this page comes from