VXVX Docs

Policy

PolicyConfig — connection timeouts and buffers

Connection policy is set in ServerConfig.policy (PolicyConfig). Schema: protos/proto/vx/policy.proto.

All timeout values are in seconds unless noted otherwise in your deployment tooling.

PolicyConfig

FieldTypeDescription
handshakeTimeoutint32Close if no data is received after connect
connectionIdleTimeoutint32Close when idle (no transfer in either direction)
udpIdleTimeoutint32Close UDP when no uplink data
upLinkOnlyTimeoutint32After downlink finished, close if no uplink data
downLinkOnlyTimeoutint32After uplink finished, close if no downlink data
defaultBufferSizeint32Default per-connection buffer (not all protocols honor this)
userPolicyMapmap<uint32, UserPolicy>Per userLevel overrides

UserPolicy

FieldDescription
bufferSizeBuffer size for users at this level

User levels come from UserConfig userLevel on each account.

Example

{
  "policy": {
    "handshakeTimeout": 4,
    "connectionIdleTimeout": 300,
    "udpIdleTimeout": 60,
    "userPolicyMap": {
      "0": { "bufferSize": 4096 }
    }
  }
}
  • Users — userLevel per account

Comments

On this page

PolicyConfigUserPolicyExampleRelated