Skip to content

Latest commit

 

History

History
152 lines (143 loc) · 7.17 KB

File metadata and controls

152 lines (143 loc) · 7.17 KB

API Reference

简体中文 | Docs Index

This inventory is generated from go doc -short for the packages in this repository. It is a quick public-surface map; source files and tests remain the authority for exact semantics.

Packages

gnalloy.org/codec-http3

Package name: http3

const DefaultMaxFrameSize = 16 * 1024 * 1024 ...
const HandlerNameHTTP3FrameDecoder = "http3-frame-decoder" ...
const SettingQPACKMaxTableCapacity uint64 = 0x01 ...
const SettingEnableConnectProtocol uint64 = 0x08 ...
const WebTransportProtocolH3 = "webtransport-h3" ...
var ErrInvalidFrame = errors.New("http3: invalid frame") ...
func ApplyLocalControlStreamPipeline(p *channel.Pipeline, cfg PipelineConfig) error
func ApplyLocalPushStreamPipeline(p *channel.Pipeline, cfg PipelineConfig, pushID uint64) error
func ApplyLocalQPACKDecoderStreamPipeline(p *channel.Pipeline) error
func ApplyLocalQPACKEncoderStreamPipeline(p *channel.Pipeline) error
func ApplyQPACKDecoderStreamPipeline(p *channel.Pipeline) error
func ApplyQPACKEncoderStreamPipeline(p *channel.Pipeline) error
func ApplyRemoteControlStreamPipeline(p *channel.Pipeline, cfg PipelineConfig) error
func ApplyRemotePushStreamPipeline(p *channel.Pipeline, cfg PipelineConfig) error
func ApplyRemoteQPACKDecoderStreamPipeline(p *channel.Pipeline) error
func ApplyRemoteQPACKEncoderStreamPipeline(p *channel.Pipeline) error
func ApplyRequestStreamPipeline(p *channel.Pipeline, cfg PipelineConfig) error
func IsWebTransportConnectSuccess(block HeadersBlock) bool
func ValidateWebTransportPeerSettings(role WebTransportRole, settings []Setting) error
type AtomicStatsRecorder struct{ ... }
    func NewAtomicStatsRecorder() *AtomicStatsRecorder
type CancelPushFrame struct{ ... }
type ControlStreamHandler struct{ ... }
    func NewControlStreamHandler() *ControlStreamHandler
type DataFrame struct{ ... }
type Decoder struct{ ... }
    func NewDecoder(maxFrameSize int) (*Decoder, error)
type Encoder struct{}
    func NewEncoder() *Encoder
type FrameDirection uint8
    const FrameDirectionInbound FrameDirection = iota + 1 ...
type FrameType uint64
    const FrameData FrameType = 0x00 ...
type GoAwayFrame struct{ ... }
type HeaderCodecConfig struct{ ... }
type HeaderDecoder struct{ ... }
    func NewHeaderDecoder(cfg HeaderCodecConfig) *HeaderDecoder
type HeaderEncoder struct{ ... }
    func NewHeaderEncoder() *HeaderEncoder
type HeaderField struct{ ... }
type HeadersBlock struct{ ... }
    func NewWebTransportConnectRequest(req WebTransportConnectRequest) (HeadersBlock, error)
    func NewWebTransportConnectResponse(status int, headers []HeaderField) HeadersBlock
type HeadersFrame struct{ ... }
type LifecycleEvent struct{ ... }
type LifecycleEventType uint8
    const LifecycleEventSettings LifecycleEventType = iota + 1 ...
type LifecycleHandler struct{}
    func NewLifecycleHandler() *LifecycleHandler
type LocalControlStreamHandler struct{ ... }
    func NewLocalControlStreamHandler(settings []Setting) (*LocalControlStreamHandler, error)
type LocalPushIDHandler struct{ ... }
    func NewLocalPushIDHandler(pushID uint64) (*LocalPushIDHandler, error)
type MaxPushIDFrame struct{ ... }
type PipelineConfig struct{ ... }
type PipelineInitializer = func(ch channel.Channel) error
    func LocalControlStreamInitializer(cfg PipelineConfig) PipelineInitializer
    func LocalPushStreamInitializer(cfg PipelineConfig, pushID uint64) PipelineInitializer
    func QPACKDecoderStreamInitializer() PipelineInitializer
    func QPACKEncoderStreamInitializer() PipelineInitializer
    func RemoteControlStreamInitializer(cfg PipelineConfig) PipelineInitializer
    func RemotePushStreamInitializer(cfg PipelineConfig) PipelineInitializer
    func RequestStreamInitializer(cfg PipelineConfig) PipelineInitializer
type PriorityUpdateFrame struct{ ... }
type PushIDDecoder struct{ ... }
    func NewPushIDDecoder() *PushIDDecoder
type PushIDFrame struct{ ... }
type PushIDFrameEncoder struct{}
    func NewPushIDFrameEncoder() *PushIDFrameEncoder
type PushPromiseBlock struct{ ... }
type PushPromiseFrame struct{ ... }
type PushState uint8
    const PushStateIdle PushState = iota ...
type QPACKDecoderStreamDecoder struct{ ... }
    func NewQPACKDecoderStreamDecoder() *QPACKDecoderStreamDecoder
type QPACKDecoderStreamEncoder struct{}
    func NewQPACKDecoderStreamEncoder() *QPACKDecoderStreamEncoder
type QPACKDuplicate struct{ ... }
type QPACKDynamicState struct{ ... }
    func NewQPACKDynamicState(cfg QPACKDynamicStateConfig) *QPACKDynamicState
type QPACKDynamicStateConfig struct{ ... }
type QPACKDynamicTable struct{ ... }
    func NewQPACKDynamicTable(capacity uint64) *QPACKDynamicTable
type QPACKEncoderStreamDecoder struct{ ... }
    func NewQPACKEncoderStreamDecoder() *QPACKEncoderStreamDecoder
type QPACKEncoderStreamEncoder struct{}
    func NewQPACKEncoderStreamEncoder() *QPACKEncoderStreamEncoder
type QPACKInsertCountIncrement struct{ ... }
type QPACKInsertWithNameRef struct{ ... }
type QPACKInsertWithoutNameRef struct{ ... }
type QPACKSectionAcknowledgment struct{ ... }
type QPACKSetDynamicTableCapacity struct{ ... }
type QPACKStreamCancellation struct{ ... }
type Setting struct{ ... }
    func QPACKSettings(maxTableCapacity uint64, blockedStreams uint64) []Setting
    func RequiredWebTransportSettings(role WebTransportRole, cfg WebTransportSettings) []Setting
type SettingsFrame struct{ ... }
type StateManager struct{ ... }
    func NewStateManager(cfg StateManagerConfig) (*StateManager, error)
type StateManagerConfig struct{ ... }
type StatsHandler struct{ ... }
    func NewStatsHandler(recorder StatsRecorder) *StatsHandler
type StatsRecorder interface{ ... }
type StatsSnapshot struct{ ... }
type StreamType uint64
    const StreamTypeControl StreamType = 0x00 ...
type StreamTypeDecoder struct{ ... }
    func NewStreamTypeDecoder() *StreamTypeDecoder
type StreamTypeEncoder struct{ ... }
    func NewStreamTypeEncoder(streamType StreamType) *StreamTypeEncoder
type StreamTypeFrame struct{ ... }
type StreamTypeGuard struct{ ... }
    func NewStreamTypeGuard(expected StreamType) *StreamTypeGuard
type UnknownFrame struct{ ... }
type WebTransportConnectRequest struct{ ... }
    func ParseWebTransportConnectRequest(block HeadersBlock) (WebTransportConnectRequest, error)
type WebTransportRole uint8
    const WebTransportRoleClient WebTransportRole = iota + 1 ...
type WebTransportSettings struct{ ... }

gnalloy.org/codec-http3/http1bridge

Package name: http1bridge

var ErrInvalidHeadersBlock = errors.New("gnalloy/codec/http3/http1bridge: invalid headers block")
func HeadersBlockFromRequest(req http1.Request, scheme string) http3.HeadersBlock
func HeadersBlockFromResponse(resp http1.Response) http3.HeadersBlock
func HeadersBlockFromTrailers(trailers http1.Headers) http3.HeadersBlock
func RequestFromHeadersBlock(block http3.HeadersBlock) (http1.Request, error)
func ResponseFromHeadersBlock(block http3.HeadersBlock) (http1.Response, error)
func TrailersFromHeadersBlock(block http3.HeadersBlock) (http1.Headers, error)
type Config struct{ ... }
type FrameToHTTPObjectCodec struct{ ... }
    func NewFrameToHTTPObjectCodec(cfg Config) *FrameToHTTPObjectCodec
type PushPromise struct{ ... }
    func PushPromiseFromBlock(block http3.PushPromiseBlock) (PushPromise, error)