poller

Documentation

Index

• Variables
• type Client
  • func New(scheme, host string, httpc *http.Client) Client

Variables

var ErrLocationExists = fmt.Errorf("location already exists")

ErrLocationExists is the error returned by AddLocation when the location is already being polled.

Types

type Client

type Client interface {
	// AddLocation creates a new forecast poll job for the given location.
	AddLocation(ctx context.Context, city, state string) error

	// Subscribe subscribes to the poller service events.
	// Cancel the context to unsubscribe and return.
	Subscribe(ctx context.Context, city, state string) (<-chan *genpoller.Forecast, error)
}

Client is the poller client interface.

func New

func New(scheme, host string, httpc *http.Client) Client

New returns a new forecast poller client.