-
-
Notifications
You must be signed in to change notification settings - Fork 194
/
provider.go
102 lines (82 loc) · 2.61 KB
/
provider.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
package provider
import (
"context"
"fmt"
"strings"
"github.com/go-spatial/geom"
"github.com/go-spatial/tegola/dict"
"github.com/go-spatial/tegola/internal/log"
)
type Tile interface {
// ZXY returns the z, x and y values of the tile
ZXY() (uint, uint, uint)
// Extent returns the extent of the tile excluding any buffer
Extent() (extent *geom.Extent, srid uint64)
// BufferedExtent returns the extent of the tile including any buffer
BufferedExtent() (extent *geom.Extent, srid uint64)
}
type Tiler interface {
// TileFeature will stream decoded features to the callback function fn
// if fn returns ErrCanceled, the TileFeatures method should stop processing
TileFeatures(ctx context.Context, layer string, t Tile, fn func(f *Feature) error) error
// Layers returns information about the various layers the provider supports
Layers() ([]LayerInfo, error)
}
type LayerInfo interface {
Name() string
GeomType() geom.Geometry
SRID() uint64
}
// InitFunc initilize a provider given a config map. The init function should validate the config map, and report any errors. This is called by the For function.
type InitFunc func(dicter dict.Dicter) (Tiler, error)
// CleanupFunc is called to when the system is shuting down, this allows the provider to cleanup.
type CleanupFunc func()
type pfns struct {
init InitFunc
cleanup CleanupFunc
}
var providers map[string]pfns
// Register the provider with the system. This call is generally made in the init functions of the provider.
// the clean up function will be called during shutdown of the provider to allow the provider to do any cleanup.
func Register(name string, init InitFunc, cleanup CleanupFunc) error {
if providers == nil {
providers = make(map[string]pfns)
}
if _, ok := providers[name]; ok {
return fmt.Errorf("provider %v already exists", name)
}
providers[name] = pfns{
init: init,
cleanup: cleanup,
}
return nil
}
// Drivers returns a list of registered drivers.
func Drivers() (l []string) {
if providers == nil {
return l
}
for k := range providers {
l = append(l, k)
}
return l
}
// For function returns a configured provider of the given type, provided the correct config map.
func For(name string, config dict.Dicter) (Tiler, error) {
if providers == nil {
return nil, fmt.Errorf("no providers registered")
}
p, ok := providers[name]
if !ok {
return nil, fmt.Errorf("no providers registered by the name: %v, known providers: %v", name, strings.Join(Drivers(), ", "))
}
return p.init(config)
}
func Cleanup() {
log.Info("cleaning up providers")
for _, p := range providers {
if p.cleanup != nil {
p.cleanup()
}
}
}