server

Documentation

Overview

Package server provides a server implementation to connect network transport protocols and service business logic by defining server endpoints.

Index

• func IsInvalidConfig(err error) bool
• func New(config Config) (microserver.Server, error)
• type Config
  • func DefaultConfig() Config

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func New

func New(config Config) (microserver.Server, error)

New creates a new configured server object.

Types

type Config

type Config struct {
	// Dependencies.
	Logger               micrologger.Logger
	Router               *mux.Router
	Service              *service.Service
	TransactionResponder microtransaction.Responder

	// Settings.
	ServiceName string
}

Config represents the configuration used to create a new server object.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new server object by best effort.