output

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 11, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DirectionClientToHost = protocol.DirectionClientToHost
	DirectionHostToClient = protocol.DirectionHostToClient

	KindInput  = protocol.KindInput
	KindOutput = protocol.KindOutput
	// KindAtomicState carries one opaque terminal-emulator snapshot. It is a
	// distinct kind so clients can never feed snapshot bytes through their VT
	// output parser by mistake.
	KindAtomicState = protocol.KindAtomicState

	MaxHeader             = protocol.MaxHeader
	MaxPayload            = protocol.MaxPayload
	MaxAtomicStatePayload = protocol.MaxAtomicStatePayload
)

Variables

View Source 
var (
	BinaryMagic = protocol.BinaryMagic
	Version     = protocol.BinaryWireVersion
)

Binary envelope wire format. This is intentionally the same DENB envelope used by the Swift transport: magic "DENB", version 1, direction byte, kind byte, header length (u32 BE), payload length (u32 BE), JSON header, payload.

The constants live in protocol/warren.schema.json and are generated into internal/protocol/wire.go. The aliases below preserve the existing output.* API for callers in this module.

Functions

func EncodeAtomicState added in v0.10.0 

func EncodeAtomicState(sessionID string, epoch, sequence uint64, format string, payload []byte) ([]byte, error)

func EncodeInput 

func EncodeInput(metadata InputMetadata, payload []byte) ([]byte, error)

func EncodeOutput 

func EncodeOutput(sessionID string, epoch, sequence uint64, payload []byte) ([]byte, error)

func SplitPayload 

func SplitPayload(payload []byte) [][]byte

SplitPayload splits one logical payload into MaxPayload-sized chunks so a large checkpoint replay can be sequenced into valid frames.

Types

type Anchor 

type Anchor struct {
	Epoch    uint64 `json:"epoch"`
	Sequence uint64 `json:"sequence"`
}

Anchor identifies the next byte a client needs within one epoch.

type DecodedAtomicState added in v0.10.0 

type DecodedAtomicState struct {
	SessionID string
	Epoch     uint64
	Sequence  uint64
	Format    string
	Payload   []byte
}

func DecodeAtomicState added in v0.10.0 

func DecodeAtomicState(data []byte) (DecodedAtomicState, error)

type DecodedFrame 

type DecodedFrame struct {
	SessionID string
	Epoch     uint64
	Sequence  uint64
	Payload   []byte
}

func DecodeOutput 

func DecodeOutput(data []byte) (DecodedFrame, error)

DecodeOutput parses one Host-to-Client output envelope. The returned payload is a copy, so the input buffer can be reused.

type Frame 

type Frame struct {
	SessionID string
	Epoch     uint64
	Sequence  uint64
	Payload   []byte
}

Frame is one sequenced PTY output chunk. PayloadLength is derived from the payload; the wire codec keeps it explicit in the header.

func (Frame) Anchor 

func (f Frame) Anchor() Anchor

Anchor returns the next byte position after this frame.

type InputMetadata 

type InputMetadata struct {
	Version       string
	SessionID     string
	AttachmentID  string
	PayloadLength int
	Sequence      uint64
}

func DecodeInput 

func DecodeInput(data []byte) (InputMetadata, []byte, error)

type Plan 

type Plan int

Plan is the recovery strategy for a reconnecting client. 

const (
	PlanExact    Plan = iota // anchor equals the ring upper bound
	PlanTail                 // anchor is inside the retained interval
	PlanReanchor             // no anchor, wrong epoch, or anchor evicted
)

type Recovery 

type Recovery struct {
	Plan     Plan
	Epoch    uint64
	Lower    uint64
	Upper    uint64
	Frames   []Frame
	Reanchor bool
}

Recovery is the bounded reply Host sends on attach.

func (Recovery) Anchor 

func (r Recovery) Anchor() Anchor

type Ring 

type Ring struct {
	Capacity int
	MaxBytes int
	Epoch    uint64
	// contains filtered or unexported fields
}

Ring is a bounded sequence interval retained by Host for reconnecting clients. Sequence values are byte positions since the epoch start, matching the Ghostline output stream and the Swift Host OutputRing semantics.

func NewRing 

func NewRing(epoch uint64, capacity, maxBytes int, nextSequence uint64) *Ring

func (*Ring) Anchor 

func (r *Ring) Anchor() Anchor

func (*Ring) Append 

func (r *Ring) Append(sessionID string, payload []byte) (Frame, error)

Append records one frame, evicting the oldest frames to keep both the frame count and the retained byte total bounded.

func (*Ring) Frames 

func (r *Ring) Frames() []Frame

func (*Ring) Lower 

func (r *Ring) Lower() uint64

func (*Ring) Plan 

func (r *Ring) Plan(anchor *Anchor) Plan

func (*Ring) Recovery 

func (r *Ring) Recovery(anchor *Anchor) Recovery

Recovery returns the frames needed by a client. For a tail the first frame is trimmed so its header starts exactly at the requested byte; for reanchor the entire retained interval is returned and callers decide whether to send a full screen snapshot instead.

func (*Ring) Reset 

func (r *Ring) Reset(epoch, nextSequence uint64)

func (*Ring) Upper 

func (r *Ring) Upper() uint64

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.