download

Documentation

Index

• func Download(ctx context.Context, endpoint string, opts ...Option) (b []byte, err error)
• func NewTFTPTransport() http.RoundTripper
• type Option
  • func WithEndpointFunc(endpointFunc func() string) Option
  • func WithErrorOnEmptyResponse(e error) Option
  • func WithErrorOnNotFound(e error) Option
  • func WithFormat(format string) Option
  • func WithHeaders(headers map[string]string) Option
  • func WithLowSrcPort() Option

Functions

func Download

func Download(ctx context.Context, endpoint string, opts ...Option) (b []byte, err error)

Download downloads a config.

func NewTFTPTransport

func NewTFTPTransport() http.RoundTripper

NewTFTPTransport returns an http.RoundTripper capable of handling the TFTP protocol.

Types

type Option

type Option func(*downloadOptions)

Option configures the download options.

func WithEndpointFunc

func WithEndpointFunc(endpointFunc func() string) Option

WithEndpointFunc provides a function that sets the endpoint of the download options.

func WithErrorOnEmptyResponse

func WithErrorOnEmptyResponse(e error) Option

WithErrorOnEmptyResponse provides specific error to return when response is empty.

func WithErrorOnNotFound

func WithErrorOnNotFound(e error) Option

WithErrorOnNotFound provides specific error to return when response has HTTP 404 error.

func WithFormat

func WithFormat(format string) Option

WithFormat specifies the source format. This ultimately will be a yaml but may be represented in different formats. For example, the config may be base64 encoded.

func WithHeaders

func WithHeaders(headers map[string]string) Option

WithHeaders specifies any http headers that are needed for downloading the config.

func WithLowSrcPort

func WithLowSrcPort() Option

WithLowSrcPort sets low source port to download the config.