siglistener

Documentation

Overview

Package siglistener provides signal listening as a module.

Index

• type Listener
  • func New(signals ...os.Signal) *Listener
  • func (l *Listener) Init() error
  • func (l *Listener) Name() string
  • func (l *Listener) Run() error
  • func (l *Listener) Stop() error

Examples

• New

Types

type Listener

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

func New

func New(signals ...os.Signal) *Listener

Example

package main

import (
	"fmt"
	"os"
	"syscall"
	"time"

	"github.com/elisasre/go-common/service"
	"github.com/elisasre/go-common/service/module/siglistener"
)

func main() {
	// Send SIGINT after 1 second.
	go func() {
		time.Sleep(time.Second)
		syscall.Kill(syscall.Getpid(), syscall.SIGINT) //nolint: errcheck
	}()

	s := siglistener.New(os.Interrupt)
	err := service.Run(service.Modules{s})
	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println("Service exited successfully")
}

Output:

Service exited successfully

func (*Listener) Init

func (l *Listener) Init() error

func (*Listener) Name

func (l *Listener) Name() string

func (*Listener) Run

func (l *Listener) Run() error

func (*Listener) Stop

func (l *Listener) Stop() error