BindToClose API Improvements

[Herbz_Dev2106]

@PageFaults

This new change to our BindToClose API will provide a “closeReason” argument to functions called after being bound using BindToClose(). We will pass one of the following enum’s as the closeReason to bound functions.

@PageFaults

Here is an example of how this new argument might be used:

game:BindToClose(function(closeReason)
	print("Closing with reason", tostring(closeReason))
	task.wait(3)
	print("Done")
end)

What are the main advantages of doing this specifically; instead of just using your own?

---

@PageFaults

Close Reason	Description
Unknown	The server shut down for an unknown reason.
RobloxMaintenance	The server shut down for maintenance.
DeveloperShutdown	The experience developer has shut down the server, or functions bound by BindToClose() have been called inside Studio.
DeveloperUpdate	The experience developer has migrated the server to a new place version.
ServerEmpty	The last player has left and the experience is empty.
OutOfMemory	The experience has hit the memory limit for the game server.

Also, how do you provide either of these, to determine the shutdown type?

[mitex7183 (mitex)]

Better server shut down handling i assume, you’d be able to run different functions depending on the close reason

[JohhnyLegoKing]

The DeveloperUpdate one can be quite useful as a signal to teleport players to a new server

[Disgustedorito (Disgustedorite)]

This sounds like a great change! I can imagine devs could make use of this to track unexpected server shutdowns, which might be very useful for finding memory leaks.

[PrestigeToken (token)]

so unkown but absolute W update

[apenzijncoolenleuk1 (Apenz1)]

Will this become integrated as an analytics stat?

[Cuteboi1234A (prosebee)]

how would we know when the game is shutting down exactly? like after the task.wait in the function?

[good_evening]

The documentation of BindToClose states that “Multiple functions can be bound using BindToClose if it is called repeatedly. The game will wait a maximum of 30 seconds for all bound functions to complete running before shutting down. After 30 seconds, the game will shut down regardless if all bound functions have completed or not.”

[ChiefWildin]

It would be awesome if this could be added to our analytics as well. Would love to see a chart of average server lifetimes, as well as a display of which of these close reasons happens more often. It could be an actionable signal if we were to see high numbers of OutOfMemory, for example.

[SoftwareDoctor (scottricity)]

currently looking for the “omg i’ve waited for soooo many years, finally my life is fulfilled!” ahh comment

[PageFaults]

It is, Someone posted this helpful image in another thread.

Add "Reason" parameter to game.BindToClose

I think this may be coming [image]

[HealthyKarl]

There’s a Memory Limit? What’s the Memory Limit even?

[PageFaults]

Just to clarify, When you now bind a function using BindToClose, The game server itself will pass the enum to your bound function as the first parameter. It’s not necessary for you to pass anything in your own code.

Previously creators didn’t have direct information as to why the server was closing.

[unix_system]

Memory limit for most servers is 6.5GB, whilst for larger (600?+) servers it’s 12GB.

[PageFaults]

Thanks!

We’re hoping creators find this useful for a variety of scenarios! Some experience developers who tested this feature have also found this helpful for tracking down memory leaks by collecting information for servers that shutdown due to the OutOfMemory reason.

[PageFaults]

It’s not part of this update but it is something we want to consider for the future!

[QALOLTHING (QA_LOL)]

W update. This will help track why my servers keep crashing

[PageFaults]

This announcement also provides some information around game servers and memory limits: Increasing Server Memory Experiments

[sayer80 (sayercito)]

Thanks a lot! This is such a good change! Our game had a problem in the early days where memory leaks caused server crashes. Everyone in the server would lose their hard-earned winstreaks if they were mid-game during a server crash.

Now, this seems to never happen, but if it ever does, I can be confident that they won’t be recognized as having “left the game during a match” and losing their winstreak, because BindToClose automatically removes the mid-game status in our game.

[RaterixRGL (Raterix)]

This helps improve the migration feature, it allows us to trigger migration teleports when necessary.

It helps, but not 100%, and I appreciate that this was added. It’s very useful.