client

Documentation

Index

• Constants
• Variables
• func Dial(url string, header http.Header) (*websocket.Conn, *http.Response, error)
• func SameDomainRedirectPolicy() resty.RedirectPolicyFunc
• type Client
  • func NewClient(opts ...Opt) Client
• type LeveledLogger
  • func (l *LeveledLogger) Debugf(msg string, keysAndValues ...interface{})
  • func (l *LeveledLogger) Errorf(msg string, keysAndValues ...interface{})
  • func (l *LeveledLogger) Warnf(msg string, keysAndValues ...interface{})
• type Opt
  • func WithHost(host string) Opt
  • func WithLogger(logger *logrus.Logger) Opt
  • func WithPort(port int) Opt
  • func WithScheme(scheme string) Opt
  • func WithURL(u *url.URL) Opt

Constants

const (
	DeviceUIDHeader = "X-Device-UID"
)

Variables

var (
	ErrConnectionFailed = errors.New("connection failed")
	ErrNotFound         = errors.New("not found")
	ErrUnknown          = errors.New("unknown error")
)

Functions

func Dial

func Dial(url string, header http.Header) (*websocket.Conn, *http.Response, error)

Dial creates a websocket connection to ShellHub's SSH server.

It receivees the endpoint to connect and the necessary headers for authentication on the server. If the server redirect the connection with status http.StatusTemporaryRedirect or http.StatusPermanentRedirect, the Dial method will follow. Any other response from the server will result in an error as result of this function.

func SameDomainRedirectPolicy

func SameDomainRedirectPolicy() resty.RedirectPolicyFunc

SameDomainRedirectPolicy allows redirect only if the redirected domain is the same as original domain, e.g. redirect to "www.imroc.cc" from "imroc.cc" is allowed, but redirect to "google.com" is not allowed.

Types

type Client

type Client interface {
	// contains filtered or unexported methods
}

func NewClient

func NewClient(opts ...Opt) Client

type LeveledLogger

type LeveledLogger struct {
	Logger *logrus.Logger
}

func (*LeveledLogger) Debugf

func (l *LeveledLogger) Debugf(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Errorf

func (l *LeveledLogger) Errorf(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Warnf

func (l *LeveledLogger) Warnf(msg string, keysAndValues ...interface{})

type Opt

type Opt func(*client) error

func WithHost

func WithHost(host string) Opt

func WithLogger

func WithLogger(logger *logrus.Logger) Opt

func WithPort

func WithPort(port int) Opt

func WithScheme

func WithScheme(scheme string) Opt

func WithURL

func WithURL(u *url.URL) Opt