tiny

README

tiny

tiny is a Go library for rapid prototyping backend applications. It's basically a wrapper around popular Go libraries. It provides a common interface for starting various network servers, such as TCP, HTTP or gRPC and handling connections to databases, such as Postgres, sqlite or redis. Dependencies containing references to CGO are intentionally avoided and Pure-Go implementations are selected instead.

Install

go get github.com/mkorman9/tiny

Example

package main

import (
	"github.com/gofiber/fiber/v2"
	"github.com/gookit/config/v2"
	"github.com/mkorman9/tiny"
	"github.com/mkorman9/tiny/tinyhttp"
	"github.com/mkorman9/tiny/tinytcp"
)

func main() {
	tiny.Init()

	httpServer := tinyhttp.NewServer(
		config.String("http.address", "0.0.0.0:8080"),
	)
	httpServer.Get("/", func(c *fiber.Ctx) error {
		return c.Status(fiber.StatusOK).
			JSON(fiber.Map{
			    "message": "Hello world!",
			})
	})

	tcpServer := tinytcp.NewServer(
		config.String("tcp.address", "0.0.0.0:7000"),
	)
	tcpServer.ForkingStrategy(tinytcp.GoroutinePerConnection(
		func(socket *tinytcp.Socket) {
			socket.Write([]byte("Hello world!"))
			socket.Close()
		},
	))
	
	tiny.StartAndBlock(httpServer, tcpServer)
}

Documentation

Overview

Package tiny provides utilities for quick prototyping HTTP/gRPC/TCP servers.

Index

• func GetSecureRandomString(lengthBytes uint) (string, error)
• func Init(config ...*Config)
• func LoadConfig(files ...string) (loaded bool)
• func StartAndBlock(services ...Service)
• func TimePtrToUnix(t *time.Time) *int64
• func TimeToUnixPtr(t time.Time) *int64
• func ToPtr[V any](v V) *V
• func UnixPtrToTime(u *int64) *time.Time
• func UnixToTimePtr(u int64) *time.Time
• type Config
• type ConsoleLineHandler
• type ConsoleReader
  • func NewConsoleReader(handler ConsoleLineHandler) *ConsoleReader
  • func (c *ConsoleReader) Prompt(prompt string)
  • func (c *ConsoleReader) Start() error
  • func (c *ConsoleReader) Stop()
• type Service
• type SignalHandler
• type SignalsListener
  • func NewSignalsListener(handler SignalHandler, signals ...os.Signal) *SignalsListener
  • func (s *SignalsListener) Start() error
  • func (s *SignalsListener) Stop()

Functions

func GetSecureRandomString

func GetSecureRandomString(lengthBytes uint) (string, error)

GetSecureRandomString generates a cryptographically secure string of given length. Result string is encoded to hex.

func Init

func Init(config ...*Config)

Init initializes global logger and loads configuration from env variables and specified files.

func LoadConfig

func LoadConfig(files ...string) (loaded bool)

LoadConfig loads configuration from environment variables and optionally from the specified list of files. YAML, JSON and HCL file formats are supported. Configuration is stored into global config.Config instance.

func StartAndBlock

func StartAndBlock(services ...Service)

StartAndBlock starts all passed services in their designated goroutines and then blocks the current thread. Thread is unblocked when the process receives SIGINT or SIGTERM signals or one of the Start() functions returns an error. When exiting, StartAndBlock gracefully stops all the services by calling their Stop() functions and waiting for them to exit.

func TimePtrToUnix

func TimePtrToUnix(t *time.Time) *int64

TimePtrToUnix returns a pointer to epoch seconds in UTC timezone represented by given pointer to time.Time

func TimeToUnixPtr

func TimeToUnixPtr(t time.Time) *int64

TimeToUnixPtr returns a pointer to epoch seconds in UTC timezone represented by given time.Time

func ToPtr

func ToPtr[V any](v V) *V

ToPtr converts any value to a pointer

func UnixPtrToTime

func UnixPtrToTime(u *int64) *time.Time

UnixPtrToTime returns a pointer to time.Time by converting pointer to epoch seconds in UTC timezone

func UnixToTimePtr

func UnixToTimePtr(u int64) *time.Time

UnixToTimePtr returns a pointer to time.Time by converting epoch seconds in UTC timezone

Types

type Config

type Config struct {
	// ConfigFiles specifies a list of files that should be loaded during initialization.
	ConfigFiles []string

	// Log specifies an optional configuration for the global logger.
	Log *tinylog.Config
}

Config hold a configuration for Init(). It allows the end-user to customize core functionalities, such as global logger or locations of config files.

type ConsoleLineHandler

type ConsoleLineHandler = func(line string)

ConsoleLineHandler specifies a handler function for ConsoleReader.

type ConsoleReader

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

ConsoleReader is a Service that actively reads os.Stdin and passes read lines to the underlying handler.

func NewConsoleReader

func NewConsoleReader(handler ConsoleLineHandler) *ConsoleReader

NewConsoleReader creates new ConsoleReader.

func (*ConsoleReader) Prompt

func (c *ConsoleReader) Prompt(prompt string)

Prompt sets and enables printing defined prompt before line reading.

func (*ConsoleReader) Start

func (c *ConsoleReader) Start() error

Start implements the interface of Service.

func (*ConsoleReader) Stop

func (c *ConsoleReader) Stop()

Stop implements the interface of Service.

type Service

type Service interface {
	// Start is expected to start execution of the service and block.
	// If the execution cannot be started, or it fails abruptly, it should return a non-nil error.
	Start() error

	// Stop is expected to stop the running service gracefully and unblock the thread used by Start function.
	Stop()
}

Service represents concurrent job, that is expected to run in background for the whole lifetime of the process. Typical implementations of Service include network servers, such as HTTP or gRPC servers.

type SignalHandler

type SignalHandler func(signal os.Signal)

SignalHandler represents a handler function for OS signals.

type SignalsListener

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

SignalsListener is a listener of OS signals that implements the Service interface.

func NewSignalsListener

func NewSignalsListener(handler SignalHandler, signals ...os.Signal) *SignalsListener

NewSignalsListener creates new SignalsListener.

func (*SignalsListener) Start

func (s *SignalsListener) Start() error

Start implements the interface of Service.

func (*SignalsListener) Stop

func (s *SignalsListener) Stop()

Stop implements the interface of Service.