Error disconnecting clients

[AtomicSponge]

🐛 Error disconnecting clients

Strange behavior when disconnecting a client. Still tries to send an RPC despite closed connection. Using NetworkEvents autoload.

Steps to reproduce

Please see the example project:
https://github.com/AtomicSponge/netfox-debug-sponge

Run two instances and start a server with one, then join with a client on the other. After that disconnect with the client and it will start throwing errors.

Expected behavior

Clean disconnect with no errors

Observed behavior

Throws an error trying to run an RPC in _loop while disconnected.

Versions

• Godot version: 4.5 Steam multiplayer
• netfox version: 1.25.3
• Also confirmed present in the GitHub main branch.

Notes

In addition, change the lines in close_connection() to see an error that hosting was causing. To reproduce this issue just run one instance and host/disconnect/re-host.

MRE

https://github.com/AtomicSponge/netfox-debug-sponge

[AtomicSponge]

So after getting a better understanding of the Netfox internals I know whats happening at least. With the instance of me using multiplayer.multiplayer_peer.close() it stops everything properly with NetworkEvents, but when I set it to OfflineMultiplayerPeer.new() it doesn't fire the stop signals and clients will try to ping server and because they have become a server at that point the client throws an error.

As far as I can tell when I use .close() it's calling NetworkEvents, but it's making a call to multiplayer.is_server() when already disconnected. If the following is changed in the file network-tickrate-handshake.gd changing the function stop to the following would allow it to work when .close() is called:

func stop() -> void:
	if multiplayer.peer_connected.is_connected(_handle_new_peer):
		multiplayer.peer_connected.disconnect(_handle_new_peer)

However this may be insufficient if you want to also resolve the behavior of when set to OfflineMultiplayerPeer as it does not fix that issue.

[AtomicSponge]

Error when using OfflineMultiplayerPeer (constant repeating call)

[Archists-dev]

Chiming in on this as I am getting the same error after disconnecting with the function below only if calling that function on a the client. So the following behavior:

Scenario 1 - host only:
1: Press Host
2: Call that function to close the connection on the host
3: no errors - everything as expected

Scenario 2 - Host , client:
1: create host
2: create client and connect to host
3: Call that function to close the connection on the client
4: Error loop prints every second or so

Interestingly if I enable NetworkTimeSynchronizer.stop() as commented out currently, the error goes away but a new warning happens when re-connecting the client to the host after scenario 2 - "Multiple calls to NetworkTime.start()! Are you manually calling and have NetworkEvents enabled?"

Should we run with this warning until a other solution is found?

[elementbound]

Thanks for the report @AtomicSponge @Archists-dev!

I've created #530 to fix this. When stopping a game session, I recommend calling multiplayer.multiplayer_peer.close() over setting the multiplayer peer to an offline one. This way NetworkEvents can automatically call NetworkTime.stop(), plus you can connect handlers to its signals to clean up, e.g. by freeing nodes, switching scenes, etc.

In case you do use OfflineMultiplayerPeer, make sure to call NetworkTime.stop() and clean up manually.