geoannotator

Documentation

Index

• type GeoAnnotator
  • func New(ctx context.Context, geo content.Provider, localIPs []net.IP) GeoAnnotator
  • func NewFake() GeoAnnotator

Types

type GeoAnnotator

type GeoAnnotator interface {
	annotator.Annotator
	Reload(context.Context)
	AnnotateIP(ip net.IP, geo **annotator.Geolocation) error
}

GeoAnnotator is just a regular annotator with a Reload method and an AnnotateIP method.

func New

func New(ctx context.Context, geo content.Provider, localIPs []net.IP) GeoAnnotator

New makes a new Annotator that uses IP addresses to generate geolocation and ASNumber metadata for that IP based on the current copy of MaxMind data stored in GCS.

func NewFake

func NewFake() GeoAnnotator

NewFake creates a fake GeoAnnotator that contains no data. This is to aid others in creating their own annotation services for testing.

TODO(http://github.com/m-lab/uuid-annotator/issues/38): Consider moving this fake to its own subpackage.