styx

package module

Go to main page

Versions in this module

v0

v0.5.0

Aug 8, 2026

Changes in this version

type PluginSpec

+ MaxPayload uint32

v0.4.0

Aug 7, 2026

Changes in this version

type PluginSpec

+ BurstMaxPayload uint32

v0.3.1

Aug 3, 2026

v0.3.0

Aug 3, 2026

Changes in this version

+ var ErrHeartbeatsMissed = errors.New("styx: missed consecutive heartbeats")

+ var ErrWedged = errors.New("styx: heartbeat classifier detected a wedged plugin")

+ func RegisterIdentityName(id uint64, name string)

type Event

+ Revision uint64

type HealthSnapshot

+ Revision uint64

+ type MissedHeartbeatsError struct

+ Missed int

+ func (e *MissedHeartbeatsError) Error() string

+ func (e *MissedHeartbeatsError) Is(target error) bool

type ShmGeometry

+ func (g ShmGeometry) RegionBytes() (uint64, error)

+ type WedgeKind int

+ const WedgeDispatch

+ const WedgeTransport

+ type WedgedError struct

+ Kind WedgeKind

+ func (e *WedgedError) Error() string

+ func (e *WedgedError) Is(target error) bool

v0.2.0

Aug 1, 2026

Changes in this version

+ var ErrPayloadTooLarge = errors.New("styx: payload too large")

+ var ErrPluginAlreadyStarted = errors.New("styx: plugin already started")

+ var ErrUnknownPlugin = errors.New("styx: unknown plugin")

+ var NoRestart = supervisor.NoRestart

+ type HealthSnapshot struct

+ LastError error

+ LastTransition time.Time

+ MissedHeartbeats int

+ Plugin string

+ State EventKind

type Host

+ func (h *Host) Health(name string) (HealthSnapshot, error)

type IncompatibleError

+ Kind IncompatibleKind

+ type IncompatibleKind int

+ const IncompatibleBinaryIdentity

+ const IncompatibleHandshake

type PluginCrashError

+ StderrTail []string

type PluginSpec

+ Stdio StdioSink

+ type StdioSink interface

+ WriteLine func(stream string, line []byte)

v0.1.0

Aug 1, 2026

Changes in this version

+ const ConsumeFaultEscalationDisabled

+ const PluginHeartbeatInterval

+ var ErrBackpressure = errors.New("styx: backpressure")

+ var ErrCanceled = errors.New("styx: call canceled")

+ var ErrDeadlineExceeded = errors.New("styx: deadline exceeded")

+ var ErrDrained = errors.New("styx: plugin draining")

+ var ErrHostStopped = errors.New("styx: host stopped")

+ var ErrIncompatible = errors.New("styx: incompatible handshake")

+ var ErrInvalidConfig = errors.New("styx: invalid configuration")

+ var ErrMethodNotFound = errors.New("styx: method not found")

+ var ErrOutcomeUnknown = errors.New("styx: call outcome unknown")

+ var ErrPluginStopping = errors.New("styx: plugin still stopping")

+ var ErrPluginUnavailable = errors.New("styx: plugin unavailable")

+ var ErrPoisoned = errors.New("styx: region poisoned")

+ var ErrRequestDeclined = errors.New("styx: request declined")

+ var ErrServiceNotFound = errors.New("styx: service not found")

+ var ErrStreamAlreadyClosed = errors.New("styx: stream already closed")

+ var ExpBackoff = supervisor.ExpBackoff

+ func IsRetryable(err error) bool

+ func StreamError(err error) error

+ func WithDedupKey(ctx context.Context, key DedupKey) context.Context

+ type BackoffFunc = supervisor.BackoffFunc

+ type ClientConn struct

+ func (c *ClientConn) Invoke(ctx context.Context, service, method string, req, resp proto.Message) error

+ func (c *ClientConn) InvokeID(ctx context.Context, serviceID, methodID uint64, req, resp proto.Message) error

+ func (c *ClientConn) InvokeIDFactory(ctx context.Context, serviceID, methodID uint64, req proto.Message, ...) (proto.Message, error)

+ func (c *ClientConn) OpenServerStreamID(ctx context.Context, serviceID, methodID uint64, req proto.Message) (*Stream, error)

+ func (c *ClientConn) OpenStream(ctx context.Context, service, method string, opts ...StreamOption) (*Stream, error)

+ func (c *ClientConn) OpenStreamID(ctx context.Context, serviceID, methodID uint64, opts ...StreamOption) (*Stream, error)

+ type Code uint32

+ const CodeAborted

+ const CodeAlreadyExists

+ const CodeFailedPrecondition

+ const CodeInternal

+ const CodeInvalidArgument

+ const CodeNotFound

+ const CodeOK

+ const CodeResourceExhausted

+ const CodeUnavailable

+ const CodeUnimplemented

+ const CodeUnknown

+ type ConfigError struct

+ Field string

+ Reason string

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Is(target error) bool

+ type DedupKey string

+ func DedupKeyFromContext(ctx context.Context) (DedupKey, bool)

+ type Event struct

+ Err error

+ Kind EventKind

+ Plugin string

+ Time time.Time

+ type EventKind int

+ const EventCrashed

+ const EventGaveUp

+ const EventReady

+ const EventRestarting

+ const EventStarting

+ const EventUnhealthy

+ type HandshakeOffer struct

+ Codecs []string

+ Features []string

+ ProtocolMax uint32

+ ProtocolMin uint32

+ Services []ServiceRequirement

+ Transports []Transport

+ type Host struct

+ func NewHost(cfg HostConfig) *Host

+ func (h *Host) Events() <-chan Event

+ func (h *Host) Plugin(name string) *ClientConn

+ func (h *Host) Reload(ctx context.Context, name string) error

+ func (h *Host) Start(ctx context.Context) error

+ func (h *Host) Stop(ctx context.Context) error

+ type HostConfig struct

+ Logger observe.Logger

+ Metrics observe.MetricsSink

+ MetricsInterval time.Duration

+ Plugins []PluginSpec

+ type IncompatibleError struct

+ HostOffer HandshakeOffer

+ PluginOffer HandshakeOffer

+ Reason string

+ func (e *IncompatibleError) Error() string

+ func (e *IncompatibleError) Is(target error) bool

+ type MethodDesc struct

+ Handler func(srv any, ctx context.Context, req proto.Message) (proto.Message, error)

+ MethodID uint64

+ MethodName string

+ NewRequest func() proto.Message

+ type Mutator interface

+ Freeze func(ctx context.Context) error

+ Resume func(ctx context.Context) error

+ type PluginCrashError struct

+ Dispatched bool

+ ExitStatus int

+ ExitStatusKnown bool

+ Plugin string

+ Reason string

+ func (e *PluginCrashError) Error() string

+ type PluginPanicError struct

+ Method string

+ Plugin string

+ Service string

+ Stack []byte

+ Value string

+ func (e *PluginPanicError) Error() string

+ type PluginServer struct

+ func NewPluginServer(cfg PluginServerConfig) *PluginServer

+ func (s *PluginServer) RegisterMutator(m Mutator)

+ func (s *PluginServer) RegisterService(desc *ServiceDesc, impl any)

+ func (s *PluginServer) RegisterStateRestorer(restorer StateRestorer)

+ func (s *PluginServer) RegisterStateSaver(saver StateSaver)

+ func (s *PluginServer) RegisterStreamHandler(service, method string, shape StreamShape, handler func(*Stream) error)

+ func (s *PluginServer) RegisterStreamHandlerID(serviceID, methodID uint64, shape StreamShape, handler func(*Stream) error)

+ func (s *PluginServer) Serve() error

+ type PluginServerConfig struct

+ ConsumeFaultRunThreshold int

+ ContinueAfterPanic bool

+ Metrics observe.MetricsSink

+ MetricsInterval time.Duration

+ Transports []Transport

+ type PluginSpec struct

+ Args []string

+ BinarySHA256 []byte

+ ConsumeFaultRunThreshold int

+ Env []string

+ Geometry ShmGeometry

+ HeartbeatTimeout time.Duration

+ MaxDataInflight int

+ MissedHeartbeatThreshold int

+ Name string

+ Path string

+ RequireStreaming bool

+ Restart RestartPolicy

+ Services []ServiceRequirement

+ StrictCapacity bool

+ Transport Transport

+ WedgeWindow time.Duration

+ type RestartPolicy = supervisor.RestartPolicy

+ type ServiceDesc struct

+ Methods []MethodDesc

+ ServiceID uint64

+ ServiceName string

+ Version uint32

+ type ServiceRequirement struct

+ MaxVersion uint32

+ MinVersion uint32

+ Service string

+ type ShmGeometry struct

+ HostToPlugin []ShmSizeClass

+ LifecycleReserve uint32

+ PluginToHost []ShmSizeClass

+ RingCapacity uint32

+ func GeometryDefault() ShmGeometry

+ func GeometryLean() ShmGeometry

+ type ShmSizeClass struct

+ SlabCount uint32

+ SlabSize uint32

+ type StateRestorer interface

+ RestoreState func(ctx context.Context, formatVersion uint32, data []byte) error

+ type StateSaver interface

+ SaveState func(ctx context.Context) ([]byte, error)

+ type Status struct

+ Code Code

+ Details []*anypb.Any

+ Message string

+ func (s *Status) Error() string

+ type Stream struct

+ func (s *Stream) CloseSend(ctx context.Context, payload []byte) error

+ func (s *Stream) Context() context.Context

+ func (s *Stream) Err() error

+ func (s *Stream) Marshal(m proto.Message) ([]byte, error)

+ func (s *Stream) RecvMsg(ctx context.Context) ([]byte, error)

+ func (s *Stream) SendMsg(ctx context.Context, payload []byte) error

+ func (s *Stream) Unmarshal(payload []byte, m proto.Message) error

+ type StreamOption func(*streamConfig)

+ func WithBidiStream() StreamOption

+ func WithServerStreamRequest(request []byte) StreamOption

+ func WithStreamCredits(n uint32) StreamOption

+ type StreamShape uint8

+ const BidiStreamingShape

+ const ClientStreamingShape

+ const ServerStreamingShape

+ type Transport string

+ const TransportAuto

+ const TransportSHM

+ const TransportUDS

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL