Skip to content

usage.md

Latest commit

 

History

History
53 lines (39 loc) · 2.18 KB

usage.md

File metadata and controls

53 lines (39 loc) · 2.18 KB
Raw

Usage

简体中文 | Docs Index

Requirements

  • Go 1.25 or newer, matching the module go directive.
  • A Gnalloy application, recipe, example, or benchmark harness that owns lifecycle and deployment configuration.
  • Standalone module verification should set GOWORK=off so the module is tested through its published dependency graph.

Install

go get gnalloy.org/codec-websocket@dev

Import

import "gnalloy.org/codec-websocket"

Integration Pattern

  • Frame, header, body, and decoded-content limits must be selected from the trusted boundary of the service.
  • Streaming or chunked modes should be used for large payloads instead of materializing unbounded bodies.
  • Compression modules must set decoded-size limits to defend against expansion attacks.
  • ByteBuf ownership follows Gnalloy message rules: release only after the current component consumes the message.

API Selection

Use the API inventory to choose the exact constructor or option type for your protocol path:

go doc gnalloy.org/codec-websocket

Common current entry points:

  • const OpcodeContinuation = 0x0 ...
  • const CloseStatusNormalClosure uint16 = 1000 ...
  • var ErrInvalidHandshake = errors.New("gnalloy/codec/websocket: invalid websocket handshake") ...
  • type ClientHandshakeConfig struct{ ... }
  • type FrameDecoderConfig struct{ ... }
  • const FrameExtensionName = "deflate-frame" ...
  • const DefaultMaxMessageBytes = 32 << 20
  • const ExtensionName = "permessage-deflate"
  • var ErrInvalidConfig = errors.New("gnalloy/codec/websocket/deflate: invalid config") ...
  • type Config struct{ ... }

Cross-Module Assembly

When multiple Gnalloy repositories are developed together, create a local go.work file in your chosen workspace. Keep application-local replace directives out of published library modules unless the change is intentionally temporary and never committed.

Error Handling

Network input, peer behavior, platform capability, and timeout failures must be handled as normal errors. Do not recover protocol correctness by panicking. Return or propagate the module error and close the affected Channel when ownership requires it.