ctrlc

package

v0.2.111 Latest Latest Go to latest Published: Aug 13, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/superfly/flyctl

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ClearHandlers()
func HookCancelableContext(ctx context.Context, cancelFn context.CancelFunc) (context.Context, context.CancelFunc)
func HookContext(ctx context.Context) (context.Context, context.CancelFunc)
func Signals() []os.Signal
type Handle
- func Hook(event func()) Handle
- func (h Handle) Done()

Constants ¶

This section is empty.

Variables ¶

View Source

var AbortedByUser = abortedErr{}

Functions ¶

func ClearHandlers ¶

func ClearHandlers()

ClearHandlers removes all Ctrl+C signal handlers. Use with care.

func HookCancelableContext ¶

func HookCancelableContext(ctx context.Context, cancelFn context.CancelFunc) (context.Context, context.CancelFunc)

HookCancelableContext returns a context that is canceled when the user presses Ctrl+C. The context is canceled with AbortedByUser.

func HookContext ¶

func HookContext(ctx context.Context) (context.Context, context.CancelFunc)

HookContext returns a context that is canceled when the user presses Ctrl+C. The context is canceled with AbortedByUser. If you're wrapping a context that already has a cancel function, use HookCancelableContext instead.

func Signals ¶

func Signals() []os.Signal

Signals returns any signals that could correspond to Ctrl+C.

Types ¶

type Handle ¶

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

func Hook ¶

func Hook(event func()) Handle

Hook registers a function to be called when the user presses Ctrl+C. It returns a Handle, which must have its Done() method called to clean up. The event function will never be called more than once.

func (Handle) Done ¶

func (h Handle) Done()

Done cleans up signal handlers.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL