netconn

Documentation

Index

• Variables
• type DialFunc
• type FlushWriter
  • func NoopFlusher(w io.Writer) FlushWriter
• type NetConn
  • func DialNewConn(addr string, options ...Option) (NetConn, error)
  • func ErrorNetConn(err error) NetConn
• type Option
  • func WithBufferSize(size int) Option
  • func WithDialFunc(dialFunc DialFunc) Option
  • func WithReadTimeout(d time.Duration) Option
  • func WithTCPKeepAliveDuration(d time.Duration) Option
  • func WithWriteTimeout(d time.Duration) Option
• type PasswordAuth
  • func NewPasswordAuth(username string, password string) (*PasswordAuth, error)
  • func (a *PasswordAuth) GetDialFunc(dialFunc DialFunc) DialFunc

Variables

var ErrInvalidUsernamePassword = errors.New("netconn: invalid username password")

ErrInvalidUsernamePassword ...

Types

type DialFunc

type DialFunc = func(network, address string, timeout time.Duration) (net.Conn, error)

DialFunc ...

type FlushWriter

type FlushWriter interface {
	io.Writer
	Flush() error
}

FlushWriter ...

func NoopFlusher

func NoopFlusher(w io.Writer) FlushWriter

NoopFlusher ...

type NetConn

type NetConn struct {
	Writer FlushWriter
	Reader io.Reader
	Closer io.Closer
}

NetConn ...

func DialNewConn

func DialNewConn(addr string, options ...Option) (NetConn, error)

DialNewConn ...

func ErrorNetConn

func ErrorNetConn(err error) NetConn

ErrorNetConn ...

type Option

type Option func(conf *config)

Option ...

func WithBufferSize

func WithBufferSize(size int) Option

WithBufferSize ...

func WithDialFunc

func WithDialFunc(dialFunc DialFunc) Option

WithDialFunc ...

func WithReadTimeout

func WithReadTimeout(d time.Duration) Option

WithReadTimeout ...

func WithTCPKeepAliveDuration

func WithTCPKeepAliveDuration(d time.Duration) Option

WithTCPKeepAliveDuration sets the tcp keep alive duration

func WithWriteTimeout

func WithWriteTimeout(d time.Duration) Option

WithWriteTimeout ...

type PasswordAuth

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

PasswordAuth is simple ASCII password authentication

func NewPasswordAuth

func NewPasswordAuth(username string, password string) (*PasswordAuth, error)

NewPasswordAuth ...

func (*PasswordAuth) GetDialFunc

func (a *PasswordAuth) GetDialFunc(dialFunc DialFunc) DialFunc

GetDialFunc ...