maxmind

Documentation

Index

• Constants
• func New(config map[string]interface{}) (interface{}, error)
• type Client
  • func (c *Client) GeoByIp(ip string, args ...interface{}) (*Geo, error)
  • func (c *Client) Init() error
  • func (c *Client) Lookup(db int, ip net.IP, result interface{}) error
  • func (c *Client) SetCityFile(path string) error
  • func (c *Client) SetCountryFile(path string) error
• type Geo

Constants

const (
	DBCountry = 0
	DBCity    = 1
)

Functions

func New

func New(config map[string]interface{}) (interface{}, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

MaxMind Client component, configuration: components:

maxMind:
    countryFile: "@app/../geoip/GeoLite2-Country.mmdb"
    cityFile: "@app/../geoip/GeoLite2-City.mmdb"

func (*Client) GeoByIp

func (c *Client) GeoByIp(ip string, args ...interface{}) (*Geo, error)

get geo info by ip, optional args: db int: preferred geo db lang string: preferred i18n language

func (*Client) Init

func (c *Client) Init() error

func (*Client) Lookup

func (c *Client) Lookup(db int, ip net.IP, result interface{}) error

func (*Client) SetCityFile

func (c *Client) SetCityFile(path string) error

func (*Client) SetCountryFile

func (c *Client) SetCountryFile(path string) error

type Geo

type Geo struct {
	Code      string `json:"code"`               // country/area code
	Continent string `json:"-"`                  // continent name (en)
	Country   string `json:"country,omitempty"`  // country/area name (en)
	Province  string `json:"province,omitempty"` // province name (en)
	City      string `json:"city,omitempty"`     // city name(en)

	// i18n name, default is en
	I18n struct {
		Continent string
		Country   string
		Province  string
		City      string
	} `json:"-"`
}

Geo lookup result