app

Documentation

Index

• type Config
• type Environment
  • func ParseEnvironment(s string) Environment
• type Server
  • func NewServer(ctx context.Context, config *Config) (*Server, error)
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start(ctx context.Context) error

Types

type Config

type Config struct {
	DatabaseURL    string
	HTTPAddress    string
	GRPCAddress    string
	SendGridAPIKey string
	FromAddress    string
	FromName       string
	Environment    Environment
}

Config holds application configuration

type Environment

type Environment string

Environment represents the application environment

const (
	Development Environment = "development"
	Production  Environment = "production"
)

func ParseEnvironment

func ParseEnvironment(s string) Environment

ParseEnvironment parses a string into an Environment type

type Server

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

Server represents the mailman application

func NewServer

func NewServer(ctx context.Context, config *Config) (*Server, error)

NewServer creates and initializes a new application

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the application

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start starts the application services