server

Documentation

Overview

Package server provides a simple way to create a server.

Index

• Variables
• func WithContext(ctx context.Context, opts ...o.OptFunc[o.Opt, any]) (*server, context.Context)
• type Error
  • func NewError(err error) *Error
  • func (s *Error) Error() string
  • func (s *Error) Unwrap() error
• type Listener
• type Name
  • func (n Name) String() string
• type ReadyFunc
• type RunFunc
• type Server
• type ServiceEnv
• type Unimplemented
  • func (s *Unimplemented) Start(context.Context, ReadyFunc, RunFunc) func() error

Variables

var DefaultEnv = ServiceEnv{Name("SERVICE_NAME")}

DefaultEnv is the default environment variables to lookup the service name.

var ErrUnimplemented = errors.New("server: unimplemented")

ErrUnimplemented is returned when a listener is not implemented.

var Service = &service{}

Service is used to configure the service.

Functions

func WithContext

func WithContext(ctx context.Context, opts ...o.OptFunc[o.Opt, any]) (*server, context.Context)

WithContext is creating a new server with a context.

Types

type Error

type Error struct {
	Err error
}

Error ...

func NewError

func NewError(err error) *Error

NewError returns a new error.

func (*Error) Error

func (s *Error) Error() string

Error ...

func (*Error) Unwrap

func (s *Error) Unwrap() error

Unwrap ...

type Listener

type Listener interface {
	// Start is being called on the listener
	Start(context.Context, ReadyFunc, RunFunc) func() error
}

Listener is the interface to a listener, so starting and shutdown of a listener, or any routine.

type Name

type Name string

Name is used to return the service name.

func (Name) String

func (n Name) String() string

String returns the name as a string.

type ReadyFunc

type ReadyFunc func()

ReadyFunc is the function that is called by Listener to signal that it is ready and the next Listener can be called.

type RunFunc

type RunFunc func(func() error)

RunFunc is a function that is called to attach more routines to the server.

type Server

type Server interface {
	// Run is running a new go routine
	Listen(listener Listener, ready bool)

	// Waits for the server to fail,
	// or gracefully shutdown if context is canceled
	Wait() error

	// SetLimit ...
	SetLimit(n int)
}

Server is the interface to be implemented to run the server.

s, ctx := WithContext(context.Background())
s.Listen(listener, false)

if err := s.Wait(); err != nil {
	panic(err)
}

type ServiceEnv

type ServiceEnv []Name

ServiceEnv is a list of environment variables to lookup the service name.

type Unimplemented

type Unimplemented struct{}

Unimplemented is the default implementation.

func (*Unimplemented) Start

func (s *Unimplemented) Start(context.Context, ReadyFunc, RunFunc) func() error

Start ...