From 6907953a4ab01e262e6fd7b5d300965e76a5d4c5 Mon Sep 17 00:00:00 2001 From: Yujia Qiao Date: Tue, 8 Mar 2022 23:22:56 +0800 Subject: [PATCH] docs: update about heartbeat --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00fd73d4..988adac1 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ Here is the full configuration specification: [client] remote_addr = "example.com:2333" # Necessary. The address of the server default_token = "default_token_if_not_specify" # Optional. The default token of services, if they don't define their own ones -heartbeat_timeout = 40 # Optional. Set to 0 to disable the heartbeat test. Default: 40 secs +heartbeat_timeout = 40 # Optional. Set to 0 to disable the application-layer heartbeat test. The value must be greater than `server.heartbeat_interval`. Default: 40 secs [client.transport] # The whole block is optional. Specify which transport to use type = "tcp" # Optional. Possible values: ["tcp", "tls", "noise"]. Default: "tcp" @@ -137,7 +137,7 @@ local_addr = "127.0.0.1:1082" [server] bind_addr = "0.0.0.0:2333" # Necessary. The address that the server listens for clients. Generally only the port needs to be change. default_token = "default_token_if_not_specify" # Optional -heartbeat_interval = 30 # Optional. Set to 0 to disable the heartbeat. Default: 30 secs +heartbeat_interval = 30 # Optional. The interval between two application-layer heartbeat. Set to 0 to disable sending heartbeat. Default: 30 secs [server.transport] # Same as `[client.transport]` type = "tcp"