ConnectionFrameHelper Fields

1. Documentation
2. API reference
3. Microsoft.Orleans.Core
4. ConnectionFrameHelper
5. Fields

Markdown

Provides framing utilities for connection middleware authors.

Wire format per frame: [4-byte LE length] [1-byte frame type] [payload]. The length field equals 1 + payload.Length.

Connection middlewares should follow the Microsoft.AspNetCore.Connections.ConnectionDelegate pipeline pattern (like TLS) and register via SiloConnectionOptions or ClientConnectionOptions. Use these helpers for structured frame I/O within your middleware.

This helper is optional. Middleware authors who need custom protocols can read/write directly from context.Transport.Input (PipeReader) and context.Transport.Output (PipeWriter) without using this class.

DefaultMaxFrameLength

staticconst

View source

public const int DefaultMaxFrameLength

Default maximum frame length (1 MB).

FramePrefixSize

staticconst

View source

public const int FramePrefixSize

Prefix size: 4 bytes (LE length) + 1 byte (frame type) = 5 bytes.