locate

Documentation

Overview

Package locate implements a client for the Locate API v2.

Index

• Variables
• type Client
  • func NewClient(userAgent string) *Client
  • func (c *Client) Nearest(ctx context.Context, service string) ([]v2.Target, error)

Variables

var ErrNoAvailableServers = errors.New("no available M-Lab servers")

ErrNoAvailableServers is returned when there are no available servers. Batch clients should pause before scheduling a new request.

var ErrNoUserAgent = errors.New("client has no user-agent specified")

ErrNoUserAgent is returned when an empty user agent is used.

Types

type Client

type Client struct {
	// HTTPClient performs all requests. Initialized to http.DefaultClient by
	// NewClient. You may override it for alternate settings.
	HTTPClient *http.Client

	// UserAgent is the mandatory user agent to be used. Also this
	// field is initialized by NewClient.
	UserAgent string

	// BaseURL is the base url used to contact the Locate API.
	// NewClient sets the BaseURL to the -locate.url flag.
	BaseURL *url.URL
}

Client is a client for contacting the Locate API. All fields are required.

func NewClient

func NewClient(userAgent string) *Client

NewClient creates a new Client instance. The userAgent must not be empty.

func (*Client) Nearest

func (c *Client) Nearest(ctx context.Context, service string) ([]v2.Target, error)

Nearest returns a slice of nearby mlab servers. Returns an error on failure.