README
¶
Tebata（手旗）
Overview
Simple linux signal handler for Go
Installation
go get -u github.com/syossan27/tebata
Usage
package main
import (
"fmt"
"strconv"
"syscall"
"github.com/syossan27/tebata"
)
func main() {
t := tebata.New(syscall.SIGINT, syscall.SIGTERM)
// Do function when catch signal.
t.Reserve(sum, 1, 2)
t.Reserve(hello)
t.Reserve(os.Exit, 0)
for {
// Do something
}
}
func sum(firstArg, secondArg int) {
fmt.Println(strconv.Itoa(firstArg + secondArg))
}
func hello() {
fmt.Println("Hello")
}
// Expect output when type Ctrl + C:
// 3
// Hello
Why?
Look this article.
How to implement a signal handler in Go
Artwork credits
The Go gopher was designed by Renée French.
The gopher side portrait is designed by Takuya Ueda.
Licensed under the "Creative CommonsAttribution 3.0" license.
Documentation
¶
Overview ¶
Package tebata provides a way to handle OS signals gracefully.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidArgs = errors.New("invalid args argument: expected a slice")
ErrInvalidArgs is returned when invalid arguments are passed to Reserve.
var ErrInvalidFunction = errors.New("invalid function argument: expected a function")
ErrInvalidFunction is returned when a non-function is passed to Reserve.
var ErrTooFewArgs = errors.New("too few arguments: not enough arguments provided for function")
ErrTooFewArgs is returned when too few arguments are provided for the function.
var ErrTooManyArgs = errors.New("too many arguments: too many arguments provided for function")
ErrTooManyArgs is returned when too many arguments are provided for the function.
var ErrTypeMismatch = errors.New("type mismatch: function parameter types don't match provided argument types")
ErrTypeMismatch is returned when the function arguments don't match the provided arguments.
Functions ¶
This section is empty.
Types ¶
type Tebata ¶
type Tebata struct {
// contains filtered or unexported fields
}
Tebata handles signal-triggered function execution.
func New ¶
New creates a new Tebata instance and starts listening for the specified signals. It uses context for better cancellation support.
Source Files
Directories