Skip to content

Commit

Permalink
fix hopping documentation: client isn't kicked in an all-dead scenario
Browse files Browse the repository at this point in the history
  • Loading branch information
HimbeerserverDE committed Dec 8, 2023
1 parent c999495 commit 0c19615
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions hop.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ var (
// Hop connects the ClientConn to the specified upstream server
// or the first working fallback server, saving the player's last server
// unless `ForceDefaultSrv` is enabled.
// If all attempts fail the client is kicked.
// If all attempts fail the client stays connected to the current server
// with the potential for inconsistent state.
// At the moment the ClientConn is NOT fixed if an error occurs
// so the player may have to reconnect.
func (cc *ClientConn) Hop(serverName string) (err error) {
Expand Down Expand Up @@ -55,7 +56,8 @@ func (cc *ClientConn) Hop(serverName string) (err error) {
// unless `ForceDefaultSrv` is enabled.
// See the documentation on `Server.Groups` in `doc/config.md`
// for details on how a specific game server is selected from the group name.
// If all attempts fail the client is kicked.
// If all attempts fail the client stays connected to the current server
// with the potential for inconsistent state.
// At the moment the ClientConn is NOT fixed if an error occurs
// so the player may have to reconnect.
func (cc *ClientConn) HopGroup(groupName string) error {
Expand Down

0 comments on commit 0c19615

Please sign in to comment.