api

Documentation

Index

• type AuthOpt
  • func WithProtocolContext(username string, password string) AuthOpt
  • func WithTransportContext(encrypted bool, remoteAddr string, cert *x509.Certificate) AuthOpt
• type Client
  • func New(addr string) (*Client, error)
  • func (c *Client) Authenticate(ctx context.Context, a ...AuthOpt) (bool, string, error)
  • func (c *Client) Close() error

Types

type AuthOpt

type AuthOpt func(o *authOptions)

func WithProtocolContext

func WithProtocolContext(username string, password string) AuthOpt

func WithTransportContext

func WithTransportContext(encrypted bool, remoteAddr string, cert *x509.Certificate) AuthOpt

type Client

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

func New

func New(addr string) (*Client, error)

func (*Client) Authenticate

func (c *Client) Authenticate(ctx context.Context, a ...AuthOpt) (bool, string, error)

func (*Client) Close

func (c *Client) Close() error