servers

README

servers

HTTP, HTTPs, gRPC, UNIX servers with configs and context

Quick-start

package main

import (
  "bytes"
  "context"
  "fmt"
  "http"
  "log"
  "sync"

  "google.golang.org/grpc"
  "github.com/go-x-pkg/servers"
)

func main() {
  var s servers.Servers

  config := `- kind: [unix, http]
  addr: /run/acme/acme.sock
- kind: inet
  host: 0.0.0.0
  port: 8000
- kind: [inet, grpc]
  host: 0.0.0.0
  port: 8443
  tls:
    enable: true
    cert-file: /etc/acme/tls.cert
    key-file: /etc/acme/tls.key
  grpc:
    # e.g. grpcurl
    reflection: true`

  if err := yaml.Unmarshal([]byte(config), &ss); err != nil {
    log.Fatalf("error unmarshal: %s", err)
  }

  listeners, err := ss.Listen()
  if len(errs) != 0 {
    listeners.Close()

    log.Fatalf("error listen: %#v", errs)
  }

  http.HandleFunc("/", func (w http.ResponseWriter, r *http.Request) {
    log.Printf("[<] %#v %#v", w, r)
  })

  ctx := context.Background()
  ctx, cancel := context.WithCancel(ctx)
  defer cancel()

  wg := sync.WaitGroup()

  wg.Add(1)
  go func() {
    defer wg.Done()

    err := listeners.ServeHTTP(
      http.DefaultServerMux,

      servers.Context(ctx),
    )
  }()

  wg.Add(1)
  go func() {
    defer wg.Done()

    err := listeners.ServeGRPC(
      func (*grpc.Server) {
        # register gRPC servers here
      },

      servers.Context(ctx),
    )
  }()

  wg.Wait()
}

Config example

- kind: [unix, http]
  addr: /run/acme/acme.sock

- kind: inet
  host: 0.0.0.0
  port: 8000

- kind: [inet, grpc]
  host: 0.0.0.0
  port: 8443
  tls:
    enable: true
    cert-file: /etc/acme/tls.cert
    key-file: /etc/acme/tls.key
  grpc:
    # e.g. grpcurl
    reflection: true

Documentation

Index

• Constants
• Variables
• type Arg
  • func Context(v context.Context) Arg
  • func FnLog(v log.FnT) Arg
  • func FnShutdownTimeout(v func() time.Duration) Arg
• type Kind
  • func NewKindFromString(v string) Kind
  • func NewKindFromStringSlice(vv []string) Kind
  • func (knd Kind) Has(v Kind) bool
  • func (knd Kind) IsEmpty() bool
  • func (knd Kind) IsSingle() bool
  • func (knd Kind) MarshalJSON() ([]byte, error)
  • func (knd Kind) MarshalYAML() (interface{}, error)
  • func (knd Kind) NewServer() Server
  • func (knd *Kind) Set(v Kind)
  • func (knd Kind) String() string
  • func (knd Kind) StringTrySingle() string
  • func (knd Kind) ToStringSlice() (vv []string)
  • func (knd *Kind) UnSet(v Kind)
  • func (knd *Kind) UnmarshalJSON(data []byte) error
  • func (knd *Kind) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Server
• type ServerBase
  • func (s *ServerBase) Dump(ctx *dumpctx.Ctx, w io.Writer)
  • func (s *ServerBase) Network() string
• type ServerINET
  • func (s *ServerINET) Addr() string
  • func (s *ServerINET) Base() *ServerBase
  • func (s *ServerINET) Dump(ctx *dumpctx.Ctx, w io.Writer)
• type ServerListener
  • func (sl *ServerListener) Addr() string
• type ServerUNIX
  • func (s *ServerUNIX) Addr() string
  • func (s *ServerUNIX) Base() *ServerBase
  • func (s *ServerUNIX) Dump(ctx *dumpctx.Ctx, w io.Writer)
• type ServerWrapped
  • func (sw *ServerWrapped) MarshalJSON() ([]byte, error)
  • func (sw *ServerWrapped) MarshalYAML() (interface{}, error)
  • func (sw *ServerWrapped) UnmarshalJSON(data []byte) error
  • func (sw *ServerWrapped) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Servers
  • func (ss *Servers) Close() []error
  • func (ss Servers) Defaultize(inetHost string, inetPort int, unixAddr string) (err error)
  • func (ss Servers) Dump(ctx *dumpctx.Ctx, w io.Writer)
  • func (ss Servers) ForEach(cb iterCb) bool
  • func (ss Servers) IntoIter() iterator
  • func (ss *Servers) Listen(fnArgs ...Arg) (Servers, []error)
  • func (ss *Servers) PushINETIfNotExists(host string, port int, kind Kind)
  • func (ss *Servers) PushUnixIfNotExists(addr string, kind Kind)
  • func (ss *Servers) ServeGRPC(fnNewServer func(opts ...grpc.ServerOption) *grpc.Server, fnArgs ...Arg) error
  • func (ss *Servers) ServeHTTP(fnNewServer func(Server) http.Handler, fnArgs ...Arg) error
  • func (ss *Servers) SetPortToFirstINET(port int)
  • func (ss Servers) Validate() error
• type WithKind
  • func (wk *WithKind) Kind() Kind
• type WithNetwork

Constants

const (
	KindEmpty Kind = 0

	KindINET = 1 << (iota - 1)
	KindUNIX

	KindHTTP
	KindGRPC
)

Variables

var (
	ErrUnmarshalUnknownKind = errors.New("unknown server-kind, no server associated with kind")

	ErrTLSCertFileNotExists       = errors.New("tls cert-file doesn't exists")
	ErrTLSCertFilePathNotProvided = errors.New("tls cert-file path is not provided")

	ErrTLSKeyFileNotExists       = errors.New("tls key-file doesn't exists")
	ErrTLSKeyFilePathNotProvided = errors.New("tls key-file path is not provided")

	ErrUnixSocketParentDirNotExists = errors.New("unix socket parent dir doesn't exists")
	ErrUnixSocketPathNotProvided    = errors.New("tls key-file path is not provided")

	ErrGotBothInetAndUnix = errors.New("provided server is both unix and inet")
)

var ErrKindINETAndUNIX = errors.New("got both INET and UNIX kind")

Types

type Arg

type Arg func(*args)

func Context

func Context(v context.Context) Arg

func FnLog

func FnLog(v log.FnT) Arg

func FnShutdownTimeout

func FnShutdownTimeout(v func() time.Duration) Arg

type Kind

type Kind uint8

func NewKindFromString

func NewKindFromString(v string) Kind

func NewKindFromStringSlice

func NewKindFromStringSlice(vv []string) Kind

func (Kind) Has

func (knd Kind) Has(v Kind) bool

func (Kind) IsEmpty

func (knd Kind) IsEmpty() bool

func (Kind) IsSingle

func (knd Kind) IsSingle() bool

IsSingle is power of two algorithm.

func (Kind) MarshalJSON

func (knd Kind) MarshalJSON() ([]byte, error)

func (Kind) MarshalYAML

func (knd Kind) MarshalYAML() (interface{}, error)

func (Kind) NewServer

func (knd Kind) NewServer() Server

func (*Kind) Set

func (knd *Kind) Set(v Kind)

func (Kind) String

func (knd Kind) String() string

func (Kind) StringTrySingle

func (knd Kind) StringTrySingle() string

func (Kind) ToStringSlice

func (knd Kind) ToStringSlice() (vv []string)

func (*Kind) UnSet

func (knd *Kind) UnSet(v Kind)

func (*Kind) UnmarshalJSON

func (knd *Kind) UnmarshalJSON(data []byte) error

func (*Kind) UnmarshalYAML

func (knd *Kind) UnmarshalYAML(unmarshal func(interface{}) error) error

type Server

type Server interface {
	// contains filtered or unexported methods
}

type ServerBase

type ServerBase struct {
	WithKind    `json:",inline" yaml:",inline" bson:",inline"`
	WithNetwork `json:",inline" yaml:",inline" bson:",inline"`

	GRPC struct {
		Reflection bool `yaml:"reflection"`
	} `yaml:"grpc"`

	HTTP struct {
		ReadHeaderTimeout time.Duration `yaml:"readHeaderTimeout"`
	} `yaml:"http"`

	Pprof struct {
		Enable bool   `yaml:"enable"`
		Prefix string `yaml:"prefix"`
	} `yaml:"pprof"`
}

func (*ServerBase) Dump

func (s *ServerBase) Dump(ctx *dumpctx.Ctx, w io.Writer)

func (*ServerBase) Network

func (s *ServerBase) Network() string

type ServerINET

type ServerINET struct {
	ServerBase `json:",inline" yaml:",inline" bson:",inline"`

	Host string `yaml:"host"`
	Port int    `yaml:"port"`

	TLS struct {
		Enable   bool   `yaml:"enable"`
		CertFile string `yaml:"certFile"`
		KeyFile  string `yaml:"keyFile"`
	} `yaml:"tls"`
}

func (*ServerINET) Addr

func (s *ServerINET) Addr() string

func (*ServerINET) Base

func (s *ServerINET) Base() *ServerBase

func (*ServerINET) Dump

func (s *ServerINET) Dump(ctx *dumpctx.Ctx, w io.Writer)

type ServerListener

type ServerListener struct {
	Server
	net.Listener
}

func (*ServerListener) Addr

func (sl *ServerListener) Addr() string

type ServerUNIX

type ServerUNIX struct {
	ServerBase `json:",inline" yaml:",inline" bson:",inline"`

	Address        string      `yaml:"addr"`
	SocketFileMode os.FileMode `yaml:"socketFileMode"`
}

func (*ServerUNIX) Addr

func (s *ServerUNIX) Addr() string

func (*ServerUNIX) Base

func (s *ServerUNIX) Base() *ServerBase

func (*ServerUNIX) Dump

func (s *ServerUNIX) Dump(ctx *dumpctx.Ctx, w io.Writer)

type ServerWrapped

type ServerWrapped struct {
	Server `json:",inline" yaml:",inline" bson:",inline"`
}

ServerWrapped is struct wrapped typed server. Server + kind to unmarshal and build typed json/yaml/bson. see https://stackoverflow.com/a/35584188/723095.

func (*ServerWrapped) MarshalJSON

func (sw *ServerWrapped) MarshalJSON() ([]byte, error)

func (*ServerWrapped) MarshalYAML

func (sw *ServerWrapped) MarshalYAML() (interface{}, error)

func (*ServerWrapped) UnmarshalJSON

func (sw *ServerWrapped) UnmarshalJSON(data []byte) error

func (*ServerWrapped) UnmarshalYAML

func (sw *ServerWrapped) UnmarshalYAML(unmarshal func(interface{}) error) error

type Servers

type Servers []*ServerWrapped

func (*Servers) Close

func (ss *Servers) Close() []error

func (Servers) Defaultize

func (ss Servers) Defaultize(inetHost string, inetPort int, unixAddr string) (err error)

func (Servers) Dump

func (ss Servers) Dump(ctx *dumpctx.Ctx, w io.Writer)

func (Servers) ForEach

func (ss Servers) ForEach(cb iterCb) bool

func (Servers) IntoIter

func (ss Servers) IntoIter() iterator

func (*Servers) Listen

func (ss *Servers) Listen(fnArgs ...Arg) (Servers, []error)

func (*Servers) PushINETIfNotExists

func (ss *Servers) PushINETIfNotExists(host string, port int, kind Kind)

func (*Servers) PushUnixIfNotExists

func (ss *Servers) PushUnixIfNotExists(addr string, kind Kind)

func (*Servers) ServeGRPC

func (ss *Servers) ServeGRPC(fnNewServer func(opts ...grpc.ServerOption) *grpc.Server, fnArgs ...Arg) error

func (*Servers) ServeHTTP

func (ss *Servers) ServeHTTP(fnNewServer func(Server) http.Handler, fnArgs ...Arg) error

func (*Servers) SetPortToFirstINET

func (ss *Servers) SetPortToFirstINET(port int)

func (Servers) Validate

func (ss Servers) Validate() error

type WithKind

type WithKind struct {
	Knd Kind `json:"kind" yaml:"kind" bson:"kind"`
}

func (*WithKind) Kind

func (wk *WithKind) Kind() Kind

type WithNetwork

type WithNetwork struct {
	Net string `json:"network" yaml:"network" bson:"network"`
}