Skip to content

usage.md

Latest commit

 

History

History
43 lines (29 loc) · 1.55 KB

usage.md

File metadata and controls

43 lines (29 loc) · 1.55 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/protocol@dev

Import

import "gnalloy.org/protocol"

Integration Pattern

  • Configuration is passed through explicit constructors and option structs rather than package-level mutable state.
  • Keep hot-path defaults conservative, bounded, and allocation-aware.

API Selection

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

go doc gnalloy.org/protocol

Common current entry points:

  • var ErrInvalidConfig = errors.New("gnalloy/protocol: invalid config") ...
  • func NewServerHandler(adapter ServerAdapter, handler Handler) channel.Handler

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.