api

Documentation

Index

• type API
  • func New(oracle Oracle, logger *logrus.Logger) *API
  • func (a *API) CLICityHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) CLICountryHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) CLIHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) DefaultHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) JSONHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) NotFoundHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) PortHandler(w http.ResponseWriter, r *http.Request) *appError
  • func (a *API) Router() http.Handler
• type DefaultOracle
  • func NewOracle() *DefaultOracle
  • func (r *DefaultOracle) EnableLookupAddr()
  • func (r *DefaultOracle) EnableLookupCity(filepath string) error
  • func (r *DefaultOracle) EnableLookupCountry(filepath string) error
  • func (r *DefaultOracle) EnableLookupPort()
  • func (r *DefaultOracle) IsLookupAddrEnabled() bool
  • func (r *DefaultOracle) IsLookupCityEnabled() bool
  • func (r *DefaultOracle) IsLookupCountryEnabled() bool
  • func (r *DefaultOracle) IsLookupPortEnabled() bool
  • func (r *DefaultOracle) LookupAddr(ip net.IP) ([]string, error)
  • func (r *DefaultOracle) LookupCity(ip net.IP) (string, error)
  • func (r *DefaultOracle) LookupCountry(ip net.IP) (string, error)
  • func (r *DefaultOracle) LookupPort(ip net.IP, port uint64) error
• type Oracle
• type PortResponse
• type Response

Types

type API

type API struct {
	Template string
	IPHeader string
	// contains filtered or unexported fields
}

func New

func New(oracle Oracle, logger *logrus.Logger) *API

func (*API) CLICityHandler

func (a *API) CLICityHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) CLICountryHandler

func (a *API) CLICountryHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) CLIHandler

func (a *API) CLIHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) DefaultHandler

func (a *API) DefaultHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) JSONHandler

func (a *API) JSONHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) NotFoundHandler

func (a *API) NotFoundHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) PortHandler

func (a *API) PortHandler(w http.ResponseWriter, r *http.Request) *appError

func (*API) Router

func (a *API) Router() http.Handler

type DefaultOracle

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

func NewOracle

func NewOracle() *DefaultOracle

func (*DefaultOracle) EnableLookupAddr

func (r *DefaultOracle) EnableLookupAddr()

func (*DefaultOracle) EnableLookupCity

func (r *DefaultOracle) EnableLookupCity(filepath string) error

func (*DefaultOracle) EnableLookupCountry

func (r *DefaultOracle) EnableLookupCountry(filepath string) error

func (*DefaultOracle) EnableLookupPort

func (r *DefaultOracle) EnableLookupPort()

func (*DefaultOracle) IsLookupAddrEnabled

func (r *DefaultOracle) IsLookupAddrEnabled() bool

func (*DefaultOracle) IsLookupCityEnabled

func (r *DefaultOracle) IsLookupCityEnabled() bool

func (*DefaultOracle) IsLookupCountryEnabled

func (r *DefaultOracle) IsLookupCountryEnabled() bool

func (*DefaultOracle) IsLookupPortEnabled

func (r *DefaultOracle) IsLookupPortEnabled() bool

func (*DefaultOracle) LookupAddr

func (r *DefaultOracle) LookupAddr(ip net.IP) ([]string, error)

func (*DefaultOracle) LookupCity

func (r *DefaultOracle) LookupCity(ip net.IP) (string, error)

func (*DefaultOracle) LookupCountry

func (r *DefaultOracle) LookupCountry(ip net.IP) (string, error)

func (*DefaultOracle) LookupPort

func (r *DefaultOracle) LookupPort(ip net.IP, port uint64) error

type Oracle

type Oracle interface {
	LookupAddr(net.IP) ([]string, error)
	LookupCountry(net.IP) (string, error)
	LookupCity(net.IP) (string, error)
	LookupPort(net.IP, uint64) error
	IsLookupAddrEnabled() bool
	IsLookupCountryEnabled() bool
	IsLookupCityEnabled() bool
	IsLookupPortEnabled() bool
}

type PortResponse

type PortResponse struct {
	IP        net.IP `json:"ip"`
	Port      uint64 `json:"port"`
	Reachable bool   `json:"reachable"`
}

type Response

type Response struct {
	IP        net.IP   `json:"ip"`
	IPDecimal *big.Int `json:"ip_decimal"`
	Country   string   `json:"country,omitempty"`
	City      string   `json:"city,omitempty"`
	Hostname  string   `json:"hostname,omitempty"`
}