misc

README

miscellaneous

Description

Miscellaneous utility collections.

Requirements

Go 1.5 or above.

Installation

Run the following command to install the package:

go get amuz.es/src/go/misc

Documentation

Overview

Package misc contains Miscellaneous utility collections.

Index

• Variables
• type Handler
  • func NewHandler(ctx context.Context) Handler

Variables

var (
	// JSONCodec is a static JSON serializer and JSON deserializer handler.
	JSONCodec = json.ConfigFastest
)

Types

type Handler

type Handler interface {
	// NotifyError is an error notifier method within a concurrency environment that avoids falling in deadlock.
	NotifyError(err error)
	// Error method is a Error channel for cancellation.
	Error() <-chan error
	// Done method is a Done channel for cancellation.
	Done() <-chan struct{}
	// GracefulWait is a graceful shutdown method while the dependents are safely released.
	// It acts like a "WaitGroup.Wait" method.
	GracefulWait()
	// IncreaseWait is an acquiring method for a dependent.
	// It acts like a "WaitGroup.Add(1)" method.
	IncreaseWait()
	// DecreaseWait is an release method for a dependent.
	// It acts like a "WaitGroup.Done" method.
	DecreaseWait()
}

Handler is context handler with sync.WaitGroup and error notifier.

func NewHandler

func NewHandler(ctx context.Context) Handler

NewHandler returns an initialized Handler interface.