common

package
v3.50.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2018 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrNoClue is for the situation that existing information is not enough to make a decision. For example, Router may return this error when there is no suitable route.
	ErrNoClue = errors.New("not enough information for making a decision")
)

Functions

func Close added in v3.8.1 

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 Error2 added in v3.17.1 

func Error2(v interface{}, err error) error

Error2 returns the err from the 2nd parameter.

func Must 

func Must(err error)

Must panics if err is not nil.

func Must2 

func Must2(v interface{}, err error) interface{}

Must2 panics if the second parameter is not nil, otherwise returns the first parameter.

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 ChainedClosable added in v3.11.1 

type ChainedClosable []Closable

func NewChainedClosable added in v3.11.1 

func NewChainedClosable(c ...Closable) ChainedClosable

func (ChainedClosable) Close added in v3.11.1 

func (cc ChainedClosable) Close() error

type Closable added in v3.8.1 

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 HasType added in v3.11.1 

type HasType interface {
	// Type returns the type of the object.
	// Usually it returns (*Type)(nil) of the object.
	Type() interface{}
}

HasType is the interface for objects that knows its type.

type Runnable added in v3.8.1 

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.

Source Files

View all Source files

Directories

Path Synopsis
Package buf provides a light-weight memory allocation mechanism.
 Package buf provides a light-weight memory allocation mechanism.
Package crypto provides common crypto libraries for V2Ray.
 Package crypto provides common crypto libraries for V2Ray.
internal
Package dice contains common functions to generate random number.
 Package dice contains common functions to generate random number.
Package errors is a drop-in replacement for Golang lib 'errors'.
 Package errors is a drop-in replacement for Golang lib 'errors'.
errorgen
net
Package net is a drop-in replacement to Golang's net package, with some more functionalities.
 Package net is a drop-in replacement to Golang's net package, with some more functionalities.
testing
ctlcmd
bittorrent
http
tls
tls/cert
Package session provides functions for sessions of incoming requests.
 Package session provides functions for sessions of incoming requests.
done
pubsub
semaphore

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.