common

Documentation

Index

• Constants
• func GetProgramDir() string
• func HumanFriendlyTraffic(bytes uint64) string
• func Must(err error)
• func Must2(_ interface{}, err error)
• func NewBufioReadWriter(rw io.ReadWriter) *bufio.ReadWriter
• func ReadByte(r io.Reader) (byte, error)
• func RegisterOptionHandler(h OptionHandler)
• func SHA224String(password string) string
• type Address
  • func NewAddress(host string, port int, network string) *Address
  • func (a *Address) Network() string
  • func (a *Address) ResolveIP(preferV4 bool) (net.IP, error)
  • func (a *Address) String() string
• type AddressType
• type Error
  • func NewError(info string) *Error
  • func (e *Error) Base(err error) *Error
  • func (e *Error) Error() string
• type Notifier
  • func NewNotifier() *Notifier
  • func (n *Notifier) Signal()
  • func (n *Notifier) Wait() <-chan struct{}
• type OptionHandler
  • func PopOptionHandler() (OptionHandler, error)
• type RewindConn
  • func NewRewindConn(conn net.Conn) *RewindConn
  • func (c *RewindConn) Read(p []byte) (int, error)
• type RewindReadWriteCloser
  • func NewRewindReadWriteCloser(rwc io.ReadWriteCloser) *RewindReadWriteCloser
  • func (rwc *RewindReadWriteCloser) Close() error
  • func (rwc *RewindReadWriteCloser) Write(p []byte) (int, error)
• type RewindReader
  • func NewRewindReader(r io.Reader) *RewindReader
  • func (r *RewindReader) Discard(n int) (int, error)
  • func (r *RewindReader) Read(p []byte) (int, error)
  • func (r *RewindReader) ReadByte() (byte, error)
  • func (r *RewindReader) Rewind()
  • func (r *RewindReader) SetBufferSize(size int)
  • func (r *RewindReader) StopBuffering()
• type Runnable

Constants

const (
	KiB = 1024
	MiB = KiB * 1024
	GiB = MiB * 1024
)

const (
	Version = "v0.4.5"
)

Functions

func GetProgramDir

func GetProgramDir() string

func HumanFriendlyTraffic

func HumanFriendlyTraffic(bytes uint64) string

func Must

func Must(err error)

func Must2

func Must2(_ interface{}, err error)

func NewBufioReadWriter

func NewBufioReadWriter(rw io.ReadWriter) *bufio.ReadWriter

func ReadByte

func ReadByte(r io.Reader) (byte, error)

func RegisterOptionHandler

func RegisterOptionHandler(h OptionHandler)

func SHA224String

func SHA224String(password string) string

Types

type Address

type Address struct {
	net.Addr

	DomainName  string
	Port        int
	NetworkType string
	net.IP
	AddressType
}

func NewAddress

func NewAddress(host string, port int, network string) *Address

func (*Address) Network

func (a *Address) Network() string

func (*Address) ResolveIP

func (a *Address) ResolveIP(preferV4 bool) (net.IP, error)

func (*Address) String

func (a *Address) String() string

type AddressType

type AddressType byte

const (
	IPv4       AddressType = 1
	DomainName AddressType = 3
	IPv6       AddressType = 4
)

type Error

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

func NewError

func NewError(info string) *Error

func (*Error) Base

func (e *Error) Base(err error) *Error

func (*Error) Error

func (e *Error) Error() string

type Notifier

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

Notifier is a utility for notifying changes. The change producer may notify changes multiple time, and the consumer may get notified asynchronously.

func NewNotifier

func NewNotifier() *Notifier

NewNotifier creates a new Notifier.

func (*Notifier) Signal

func (n *Notifier) Signal()

Signal signals a change, usually by producer. This method never blocks.

func (*Notifier) Wait

func (n *Notifier) Wait() <-chan struct{}

Wait returns a channel for waiting for changes. The returned channel never gets closed.

type OptionHandler

type OptionHandler interface {
	Name() string
	Handle() error
	Priority() int
}

func PopOptionHandler

func PopOptionHandler() (OptionHandler, error)

type RewindConn

type RewindConn struct {
	R *RewindReader
	net.Conn
}

func NewRewindConn

func NewRewindConn(conn net.Conn) *RewindConn

func (*RewindConn) Read

func (c *RewindConn) Read(p []byte) (int, error)

type RewindReadWriteCloser

type RewindReadWriteCloser struct {
	*RewindReader
	// contains filtered or unexported fields
}

func NewRewindReadWriteCloser

func NewRewindReadWriteCloser(rwc io.ReadWriteCloser) *RewindReadWriteCloser

func (*RewindReadWriteCloser) Close

func (rwc *RewindReadWriteCloser) Close() error

func (*RewindReadWriteCloser) Write

func (rwc *RewindReadWriteCloser) Write(p []byte) (int, error)

type RewindReader

type RewindReader struct {
	io.Reader
	io.ByteReader
	// contains filtered or unexported fields
}

func NewRewindReader

func NewRewindReader(r io.Reader) *RewindReader

func (*RewindReader) Discard

func (r *RewindReader) Discard(n int) (int, error)

func (*RewindReader) Read

func (r *RewindReader) Read(p []byte) (int, error)

func (*RewindReader) ReadByte

func (r *RewindReader) ReadByte() (byte, error)

func (*RewindReader) Rewind

func (r *RewindReader) Rewind()

func (*RewindReader) SetBufferSize

func (r *RewindReader) SetBufferSize(size int)

func (*RewindReader) StopBuffering

func (r *RewindReader) StopBuffering()

type Runnable

type Runnable interface {
	Run() error
	Close() error
}