Skip to content

usage.md

Latest commit

 

History

History
60 lines (46 loc) · 2.66 KB

usage.md

File metadata and controls

60 lines (46 loc) · 2.66 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-http2@dev

Import

import "gnalloy.org/codec-http2"

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.
  • HTTP/2 over TLS requires TLS 1.2 or newer and ALPN h2; h2c must be configured as a cleartext upgrade path.

API Selection

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

go doc gnalloy.org/codec-http2

Common current entry points:

  • const ClientPreface = "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n" ...
  • const SettingHeaderTableSize uint16 = 0x1 ...
  • const ErrorCodeCancel uint32 = 0x8
  • var ErrInvalidFrame = errors.New("gnalloy/codec/http2: invalid frame") ...
  • type ConnectionControllerConfig struct{ ... }
  • type FrameEncoderConfig struct{ ... }
  • type HeaderCodecConfig struct{ ... }
  • type MultiplexerConfig struct{ ... }
  • type OutboundFlowControlConfig struct{ ... }
  • type StreamBufferingEncoderConfig struct{ ... }
  • type StreamChildConfig struct{ ... }
  • func NewDataCompressingInput(streamID http2.StreamID, input codec.ChunkedInput, coding Coding, ...) (*h2chunked.DataChunkedInput, error)
  • type DataCompressingInputConfig struct{ ... }
  • type ResponseCompressorConfig struct{ ... }
  • var ErrTooManyRSTFrames = errors.New("gnalloy/codec/http2/defense: too many rst_stream frames") ...
  • type ControlFrameLimitConfig 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.