client

Documentation

Overview

Package client provides a client for the router API.

Index

• Variables
• type Client
  • func New() Client
  • func NewWithAddr(addr string) Client
  • func NewWithHTTP(http *http.Client) Client

Variables

var ErrNotFound = errors.New("router: route not found")

ErrNotFound is returned when no route was found.

Types

type Client

type Client interface {
	// StreamEvents streams router events with the given options
	StreamEvents(opts *router.StreamEventsOptions, output chan *router.StreamEvent) (stream.Stream, error)
}

Client is a client for the router API.

func New

func New() Client

New uses the default discoverd client and returns a client.

func NewWithAddr

func NewWithAddr(addr string) Client

NewWithAddr uses addr as the specified API url and returns a client.

func NewWithHTTP

func NewWithHTTP(http *http.Client) Client

NewWithHTTP does the same thing as New but uses the given *http.Client