cheykrym/frp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify heartbeat vs tcpMux keepalive

Browse Source 
Co-authored-by: fatedier <7346661+fatedier@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2026-02-03 03:21:26 +00:00
parent d823f7e98b
commit 1bbbbaac85
4 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
conf/frpc_full_example.toml
View File

@ -133,7 +133,9 @@ transport.tls.enable = true
# transport.tls.disableCustomTLSFirstByte = true # transport.tls.disableCustomTLSFirstByte = true
# Heartbeat configure, it's not recommended to modify the default value. # Heartbeat configure, it's not recommended to modify the default value.
# The default value of heartbeatInterval is 10 and heartbeatTimeout is 90. Set negative value # If tcpMux is enabled (default), heartbeat is disabled and tcp mux keepalive
# interval controls the liveness detection instead.
# The default value of heartbeatInterval is 30 and heartbeatTimeout is 90. Set negative value
# to disable it. # to disable it.
# transport.heartbeatInterval = 30 # transport.heartbeatInterval = 30
# transport.heartbeatTimeout = 90 # transport.heartbeatTimeout = 90

4
conf/frps_full_example.toml
View File

@ -22,7 +22,9 @@ kcpBindPort = 7000
# transport.quic.maxIdleTimeout = 30 # transport.quic.maxIdleTimeout = 30
# transport.quic.maxIncomingStreams = 100000 # transport.quic.maxIncomingStreams = 100000
# Heartbeat configure, it's not recommended to modify the default value # Heartbeat configure, it's not recommended to modify the default value.
# If tcpMux is enabled (default), heartbeat is disabled and tcp mux keepalive
# interval controls the liveness detection instead.
# The default value of heartbeatTimeout is 90. Set negative value to disable it. # The default value of heartbeatTimeout is 90. Set negative value to disable it.
# transport.heartbeatTimeout = 90 # transport.heartbeatTimeout = 90

2
pkg/config/v1/client.go
View File

@ -133,6 +133,8 @@ type ClientTransportConfig struct {
// HeartBeatTimeout specifies the maximum allowed heartbeat response delay // HeartBeatTimeout specifies the maximum allowed heartbeat response delay
// before the connection is terminated, in seconds. It is not recommended // before the connection is terminated, in seconds. It is not recommended
// to change this value. By default, this value is 90. Set negative value to disable it. // to change this value. By default, this value is 90. Set negative value to disable it.
// Note: When TCPMux is enabled (default), heartbeat checks are disabled and
// the TCP mux keepalive interval controls liveness instead.
HeartbeatTimeout int64 `json:"heartbeatTimeout,omitempty"` HeartbeatTimeout int64 `json:"heartbeatTimeout,omitempty"`
// TLS specifies TLS settings for the connection to the server. // TLS specifies TLS settings for the connection to the server.
TLS TLSClientConfig `json:"tls,omitempty"` TLS TLSClientConfig `json:"tls,omitempty"`

2
pkg/config/v1/server.go
View File

@ -172,6 +172,8 @@ type ServerTransportConfig struct {
// HeartBeatTimeout specifies the maximum time to wait for a heartbeat // HeartBeatTimeout specifies the maximum time to wait for a heartbeat
// before terminating the connection. It is not recommended to change this // before terminating the connection. It is not recommended to change this
// value. By default, this value is 90. Set negative value to disable it. // value. By default, this value is 90. Set negative value to disable it.
// Note: When TCPMux is enabled (default), heartbeat checks are disabled and
// the TCP mux keepalive interval controls liveness instead.
HeartbeatTimeout int64 `json:"heartbeatTimeout,omitempty"` HeartbeatTimeout int64 `json:"heartbeatTimeout,omitempty"`
// QUIC options. // QUIC options.
QUIC QUICOptions `json:"quic,omitempty"` QUIC QUICOptions `json:"quic,omitempty"`