leakless

README

leakless

Run sub-process and make sure to kill it when the parent process exits. The way how it works is to output a standalone executable file to guard the subprocess and check parent TCP connection with a UUID. So that it works consistently on Linux, Mac, and Windows.

Not using the PID is because after a process exits, a newly created process may have the same PID.

How to Use

See the examples.

Documentation

Index

• func GetLeaklessBin() string
• func Support() bool
• type Launcher
  • func New() *Launcher
  • func (l *Launcher) Command(name string, arg ...string) *exec.Cmd
  • func (l *Launcher) Err() string
  • func (l *Launcher) Pid() chan int

Examples

• New

Functions

func GetLeaklessBin

func GetLeaklessBin() string

GetLeaklessBin returns the executable path of the guard. Usually you use it to prevent race condition of the file creation of the guard bin.

func Support

func Support() bool

Support returns true if the OS is supported by leakless.

Types

type Launcher

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

Launcher struct

func New

func New() *Launcher

New leakless instance

Example

package main

import (
	"fmt"
	"time"

	"github.com/ysmood/leakless"
)

func main() {
	ll := leakless.New()

	// just like using the exec.Command
	_ = ll.Command("sleep", "3").Start()

	// get the pid of the guarded sub-process
	select {
	case <-time.Tick(3 * time.Second):
		panic("timeout")
	case pid := <-ll.Pid():
		fmt.Println(pid)
	}
}

func (*Launcher) Command

func (l *Launcher) Command(name string, arg ...string) *exec.Cmd

Command will try to download the leakless bin and prefix the exec.Cmd with the leakless options.

func (*Launcher) Err

func (l *Launcher) Err() string

Err message from the guard process

func (*Launcher) Pid

func (l *Launcher) Pid() chan int

Pid signals the pid of the guarded sub-process. The channel may never receive the pid.