Skip to content

README.md

Latest commit

 

History

History
61 lines (44 loc) · 2.66 KB

README.md

File metadata and controls

61 lines (44 loc) · 2.66 KB
Raw

WSC — Bindings

A binding is a language-specific, I/O-free implementation of the WSC wire format. It exposes the protocol as idiomatic types, functions, and constants in a target language — with no opinion on how packets are transported.

What a Binding Provides

Responsibility Description
Packet construction Build a typed packet from structured inputs via a factory method
Serialization Encode a packet to a byte buffer
Deserialization Decode a byte buffer into a typed packet
Payload codecs Per-message-type encode / decode of the payload region
Address construction Build and parse WSC addresses from token sequences or dot-notation strings
Transport Descriptor construction Assemble a TD from protocol, interface, and address inputs via factory methods
Validation Enforce flag invariants and compatibility matrices before send

What a Binding Does NOT Provide

  • Network I/O of any kind
  • Connection management or session state
  • Downstream protocol translation (gateway logic)

Available Bindings

Language Path Protocol version SDK version Status
JavaScript / TypeScript js/ 1.1.0 3.0.0 Stable

Adding a New Binding

  1. Create a directory bindings/<language>/.
  2. Add a README.md documenting:
    • Which protocol version is targeted
    • How to install / include the binding
    • The public API surface (types, constructors, key functions)
    • Any deviations from the specification, with justification
  3. Implement the binding against the normative specification in core/spec/.
  4. Reference the spec section in comments for non-obvious decisions.

Minimum required API surface

Every conformant binding MUST expose, in idiomatic form for the target language:

Concept Spec section
Packet type — construct, serialize, deserialize §02, §04
Flags — serialize, deserialize, validate §02 — Flags
Address — build, parse, serialize, deserialize §03
Transport Descriptor — construct, serialize, deserialize §05
Validation — returns errors and warnings §07
All enumerated constants §04, §05

Conformance

Binding authors MUST read the conformance section of the core spec before publishing a binding.