Skip to content
/ lemon Public

An engine to manage your components lifecycle.

License

Notifications You must be signed in to change notification settings

novln/lemon

Repository files navigation

Lemon

Documentation License Build Status Coverage Status Report Status

An engine to manage your components lifecycle.

Lemon

Introduction

Lemon is an engine that manage your components lifecycle using a startup and shutdown mechanism.

It will start every registered hook (or daemon, service, etc...) and block until it receives a signal (SIGINT, SIGTERM and SIGQUIT for example) or when a parent context is terminated...

NOTE: startup and shutdown procedure will be executed in separated goroutine: so be very careful with any race conditions or deadlocks.

Example

package main

import (
	"context"
	"fmt"
	"os"
	"time"

	"github.com/novln/lemon"
)

// Let's define a simple Ping hook...
type Ping struct {}

// Start will be executed when lemon's engine will try to start this Hook.
// Your hook can perfectly use the given context (see example), or any blocking operation...
func (p *Ping) Start(ctx context.Context) error {

	fmt.Println("[ping] Start")

	for {
		select {
		case <-ctx.Done():
			return nil
		case <-time.After(2 * time.Second):
			fmt.Println("[ping] Echo Request")
		}
	}
}

// However, if you don't use <-ctx.Done(), you must cancel your blocking operation in Stop.
func (p *Ping) Stop(ctx context.Context) error {
	fmt.Println("[ping] Stop")
	return nil
}

func main() {

	timeout := 5 * time.Second
	ctx := context.Background()

	engine, err := lemon.New(ctx, lemon.Timeout(timeout), lemon.Logger(func(err error) {
		fmt.Fprintln(os.Stderr, err)
	}))

	if err != nil {
		fmt.Fprintln(os.Stderr, err)
		os.Exit(255)
	}

	engine.Register(&Ping{})
	engine.Start()

}

Versioning or Vendoring

Expect compatibility break from master branch.

Using Go dependency management tool is highly recommended.

NOTE: semver tags or branches could be provided, if needed.

License

This is Free Software, released under the MIT License.