server

Documentation

Overview

Package server implements the http frontend

Index

• Constants
• Variables
• func RegisterMap(m Map) error
• func Start(port string)
• type Capabilities
• type CapabilitiesLayer
• type CapabilitiesMap
• type HandleCapabilities
  • func (req HandleCapabilities) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandleMapCapabilities
  • func (req HandleMapCapabilities) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandleMapLayerZXY
  • func (req HandleMapLayerZXY) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandleMapZXY
  • func (req HandleMapZXY) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Layer
• type Logger
  • func (l *Logger) Log(item logItem)
• type Map
  • func NewMap(name string) Map
  • func (m *Map) FilterLayersByName(name string) (filteredLayers []Layer)
  • func (m *Map) FilterLayersByZoom(zoom int) (filteredLayers []Layer)

Constants

const (
	//	MaxTileSize is 500k. Currently just throws a warning when tile
	//	is larger than MaxTileSize
	MaxTileSize = 500000
	//	MaxZoom will not render tile beyond this zoom level
	MaxZoom = 20
)

const DefaultLogFormat = "{{.Time}}:{{.RequestIP}} —— Tile:{{.Z}}/{{.X}}/{{.Y}}"

Variables

var (
	//	set at runtime from main
	Version string
	//	configurable via the tegola config.toml file
	HostName string
)

Functions

func RegisterMap

func RegisterMap(m Map) error

RegisterMap associates layers with map names

func Start

func Start(port string)

Start starts the tile server binding to the provided port

Types

type Capabilities

type Capabilities struct {
	Version string            `json:"version"`
	Maps    []CapabilitiesMap `json:"maps"`
}

type CapabilitiesLayer

type CapabilitiesLayer struct {
	Name    string   `json:"name"`
	Tiles   []string `json:"tiles"`
	MinZoom int      `json:"minzoom"`
	MaxZoom int      `json:"maxzoom"`
}

type CapabilitiesMap

type CapabilitiesMap struct {
	Name         string              `json:"name"`
	Attribution  string              `json:"attribution"`
	Bounds       [4]float64          `json:"bounds"`
	Center       [3]float64          `json:"center"`
	Tiles        []string            `json:"tiles"`
	Capabilities string              `json:"capabilities"`
	Layers       []CapabilitiesLayer `json:"layers"`
}

type HandleCapabilities

type HandleCapabilities struct{}

func (HandleCapabilities) ServeHTTP

func (req HandleCapabilities) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HandleMapCapabilities

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

func (HandleMapCapabilities) ServeHTTP

func (req HandleMapCapabilities) ServeHTTP(w http.ResponseWriter, r *http.Request)

returns details about a map according to the tileJSON spec (https://github.com/mapbox/tilejson-spec/tree/master/2.1.0)

URI scheme: /capabilities/:map_name.json

map_name - map name in the config file

type HandleMapLayerZXY

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

func (HandleMapLayerZXY) ServeHTTP

func (req HandleMapLayerZXY) ServeHTTP(w http.ResponseWriter, r *http.Request)

URI scheme: /maps/:map_name/:layer_name/:z/:x/:y map_name - map name in the config file layer_name - name of the single map layer to render z, x, y - tile coordinates as described in the Slippy Map Tilenames specification

z - zoom level
x - row
y - column

type HandleMapZXY

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

func (HandleMapZXY) ServeHTTP

func (req HandleMapZXY) ServeHTTP(w http.ResponseWriter, r *http.Request)

URI scheme: /maps/:map_name/:z/:x/:y map_name - map name in the config file z, x, y - tile coordinates as described in the Slippy Map Tilenames specification

z - zoom level
x - row
y - column

type Layer

type Layer struct {
	Name    string
	MinZoom int
	MaxZoom int
	//	instantiated provider
	Provider mvt.Provider
	//	default tags to include when encoding the layer. provider tags take precedence
	DefaultTags map[string]interface{}
}

type Logger

type Logger struct {
	File   *os.File
	Format string
	sync.Mutex
	// contains filtered or unexported fields
}

var L *Logger

func (*Logger) Log

func (l *Logger) Log(item logItem)

type Map

type Map struct {
	Name string
	//	Contains an attribution to be displayed when the map is shown to a user.
	// 	This string is sanatized so it can't be abused as a vector for XSS or beacon tracking.
	Attribution string
	//	The maximum extent of available map tiles in WGS:84
	//	latitude and longitude values, in the order left, bottom, right, top.
	//	Default: [-180, -90, 180, 90]
	Bounds [4]float64
	//	The first value is the longitude, the second is latitude (both in
	//	WGS:84 values), the third value is the zoom level.
	Center [3]float64
	Layers []Layer
}

func NewMap

func NewMap(name string) Map

NewMap creates a new map with the necessary default values

func (*Map) FilterLayersByName

func (m *Map) FilterLayersByName(name string) (filteredLayers []Layer)

FilterByName returns a slice with the first layer that matches the provided name the slice return is for convenience. MVT tiles require unique layer names

func (*Map) FilterLayersByZoom

func (m *Map) FilterLayersByZoom(zoom int) (filteredLayers []Layer)

FilterByZoom returns layers that that are to be rendered between a min and max zoom