common

Documentation

Overview

Package common contains common utilities that are shared among other packages. See each sub-package for detail.

Index

• func Close(obj interface{}) error
• func CreateObject(ctx context.Context, config interface{}) (interface{}, error)
• func Must(err error)
• func Must2(v interface{}, err error)
• func RegisterConfig(config interface{}, configCreator ConfigCreator) error
• type Closable
• type ConfigCreator
• type Runnable

Functions

func Close

func Close(obj interface{}) error

Close closes the obj if it is a Closable.

func CreateObject

func CreateObject(ctx context.Context, config interface{}) (interface{}, error)

CreateObject creates an object by its config. The config type must be registered through RegisterConfig().

func Must

func Must(err error)

Must panics if err is not nil.

func Must2

func Must2(v interface{}, err error)

Must2 panics if the second parameter is not nil.

func RegisterConfig

func RegisterConfig(config interface{}, configCreator ConfigCreator) error

RegisterConfig registers a global config creator. The config can be nil but must have a type.

Types

type Closable

type Closable interface {
	// Close release all resources used by this object, including goroutines.
	Close() error
}

Closable is the interface for objects that can release its resources.

type ConfigCreator

type ConfigCreator func(ctx context.Context, config interface{}) (interface{}, error)

ConfigCreator is a function to create an object by a config.

type Runnable

type Runnable interface {
	// Start starts the runnable object. Upon the method returning nil, the object begins to function properly.
	Start() error

	Closable
}

Runnable is the interface for objects that can start to work and stop on demand.