proxy

Documentation

Overview

Package proxy implements the Modbus caching proxy.

Index

• type Proxy
  • func New(cfg *config.Config, logger *slog.Logger) (*Proxy, error)
  • func (p *Proxy) HandleRequest(ctx context.Context, req *modbus.Request) ([]byte, error)
  • func (p *Proxy) HealthReport() (string, map[string]any, error)
  • func (p *Proxy) HealthStatus() (string, map[string]any)
  • func (p *Proxy) Healthy() error
  • func (p *Proxy) Run(ctx context.Context) error
  • func (p *Proxy) Shutdown(timeout time.Duration) error

Types

type Proxy

type Proxy struct {
	// contains filtered or unexported fields
}

Proxy is a caching Modbus proxy server.

func New

func New(cfg *config.Config, logger *slog.Logger) (*Proxy, error)

New creates a new proxy instance.

func (*Proxy) HandleRequest

func (p *Proxy) HandleRequest(ctx context.Context, req *modbus.Request) ([]byte, error)

HandleRequest implements modbus.Handler interface.

func (*Proxy) HealthReport

func (p *Proxy) HealthReport() (string, map[string]any, error)

HealthReport returns reliability diagnostics and availability from one snapshot.

func (*Proxy) HealthStatus

func (p *Proxy) HealthStatus() (string, map[string]any)

HealthStatus returns optional upstream reliability diagnostics.

func (*Proxy) Healthy

func (p *Proxy) Healthy() error

Healthy reports whether the proxy's upstream connection is healthy.

func (*Proxy) Run

func (p *Proxy) Run(ctx context.Context) error

Run starts the proxy server.

func (*Proxy) Shutdown

func (p *Proxy) Shutdown(timeout time.Duration) error

Shutdown gracefully shuts down the proxy.