Skip to content

Compatibility Policy

v2rayroot edited this page Jun 14, 2026 · 1 revision

Compatibility Policy

Each binary is built against one upstream Xray release. Read the exact tag from GetVersionInfo.version.

Stable Contract

The public integration contract consists of:

  • Exported functions documented in this Wiki
  • Generated C header shipped with the binary
  • Memory ownership rules
  • Documented JSON result shapes

Consumer Responsibilities

  • Keep header and binary synchronized.
  • Run integration tests before adopting a release.
  • Prefer capability detection over assumptions.
  • Do not depend on internal Go symbols.
  • Do not depend on undocumented normalization behavior.

Function names remaining unchanged does not guarantee compatibility if ownership or result schemas change. Treat those changes as integration-significant.

Clone this wiki locally