server

Documentation

Index

• Variables
• func AdaptCodec[T any](codec Codec[T], o Options) transport.Codec[core.Result, core.Cmd[T]]
• func Apply(ops []SetOption, o *Options)
• type Codec
• type Invoker
  • func NewInvoker[T any](receiver T) Invoker[T]
  • func (i Invoker[T]) Invoke(ctx context.Context, seq core.Seq, at time.Time, bytesRead int, ...) error
• type Options
• type SetOption
  • func WithCore(ops ...csrv.SetOption) SetOption
  • func WithDelegate(ops ...dsrv.SetOption) SetOption
  • func WithHandler(ops ...handler.SetOption) SetOption
  • func WithServerInfo(info delegate.ServerInfo) SetOption
  • func WithTransport(ops ...transport.SetOption) SetOption
• type TransportFactory
  • func NewTransportFactory[T any](codec transport.Codec[core.Result, core.Cmd[T]], ops ...transport.SetOption) *TransportFactory[T]
  • func (f TransportFactory[T]) New(conn net.Conn) dsrv.Transport[T]

Variables

var ServerInfo = []byte("default")

ServerInfo is the default ServerInfo.

Functions

func AdaptCodec

func AdaptCodec[T any](codec Codec[T], o Options) transport.Codec[core.Result, core.Cmd[T]]

AdaptCodec adapts the provided Codec.

func Apply

func Apply(ops []SetOption, o *Options)

Types

type Codec

type Codec[T any] codec.Codec[core.Result, core.Cmd[T]]

Codec defines a generic server codec interface for encoding Results and decoding Commands.

• Encode is used by the server to send Results back to the client. If encoding fails, the server closes the corresponding client connection.
• Decode is used by the server to receive Commands. If decoding fails, the server closes the corresponding client connection.

type Invoker

type Invoker[T any] struct {
	// contains filtered or unexported fields
}

Invoker is the default implementation of the handler.Invoker interface.

It performs no additional actions other than executing the provided Command.

func NewInvoker

func NewInvoker[T any](receiver T) Invoker[T]

NewInvoker creates a new Invoker.

func (Invoker[T]) Invoke

func (i Invoker[T]) Invoke(ctx context.Context, seq core.Seq, at time.Time,
	bytesRead int, cmd core.Cmd[T], proxy core.Proxy) error

type Options

type Options struct {
	Info      delegate.ServerInfo
	Base      []csrv.SetOption
	Delegate  []dsrv.SetOption
	Handler   []handler.SetOption
	Transport []transport.SetOption
}

Options defines the configuration settings for initializing a server.

These options are composed of modular components that configure different layers of the server, including transport, handler logic, delegate behavior, and base server setup.

type SetOption

type SetOption func(o *Options)

func WithCore

func WithCore(ops ...csrv.SetOption) SetOption

WithCore applies core-level configuration options.

func WithDelegate

func WithDelegate(ops ...dsrv.SetOption) SetOption

WithDelegate applies delegate-specific options.

These options customize the behavior of the server delegate.

func WithHandler

func WithHandler(ops ...handler.SetOption) SetOption

WithHandler sets options for the connection handler.

These options customize the behavior of the connection handler.

func WithServerInfo

func WithServerInfo(info delegate.ServerInfo) SetOption

WithServerInfo sets the ServerInfo for the server.

ServerInfo helps the client identify a compatible server.

func WithTransport

func WithTransport(ops ...transport.SetOption) SetOption

WithTransport applies transport-specific options.

These options configure the transport layer.

type TransportFactory

type TransportFactory[T any] struct {
	// contains filtered or unexported fields
}

TransportFactory implements the delegate.ServerTransportFactory interface.

It creates Transports that handle encoding Results / decoding Commands over a network connection.

func NewTransportFactory

func NewTransportFactory[T any](codec transport.Codec[core.Result, core.Cmd[T]],
	ops ...transport.SetOption,
) *TransportFactory[T]

NewTransportFactory creates a new TransportFactory using the provided codec and optional transport-level configuration options.

func (TransportFactory[T]) New

func (f TransportFactory[T]) New(conn net.Conn) dsrv.Transport[T]