server

Documentation

Overview

Package server implements the http frontend

Index

• Constants
• Variables
• func RegisterMap(name string, layers []Layer) error
• func Start(port string)
• type Capabilities
• type CapabilitiesLayer
• type CapabilitiesMap
• type HandleCapabilities
  • func (req HandleCapabilities) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandleZXY
  • func (req HandleZXY) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Layer
• type Logger
  • func (l *Logger) Log(item logItem)

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 Version string

set at runtime from main

Functions

func RegisterMap

func RegisterMap(name string, layers []Layer) 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"`
	URI     string `json:"uri"`
	MinZoom int    `json:"minZoom"`
	MaxZoom int    `json:"maxZoom"`
}

type CapabilitiesMap

type CapabilitiesMap struct {
	Name   string              `json:"name"`
	URI    string              `json:"uri"`
	Layers []CapabilitiesLayer `json:"layers"`
}

type HandleCapabilities

type HandleCapabilities struct{}

func (HandleCapabilities) ServeHTTP

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

type HandleZXY

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

func (HandleZXY) ServeHTTP

func (req HandleZXY) 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)