Documentation
¶
Index ¶
- type Analytics
- type AnalyticsConfig
- type AnalyticsRegistration
- type Authentication
- type AuthenticationConfig
- type AuthenticationRegistration
- type Cache
- type CacheConfig
- type CacheRegistration
- type Check
- type CheckConfig
- type CheckRegistration
- type Datastore
- type DatastoreConfig
- type DatastoreRegistration
- type Provider
- type ProviderConfig
- type ProviderRegistration
- type RateLimit
- type RateLimitStoreConfig
- type RateLimitStoreRegistration
- type Secret
- type SecretConfig
- type SecretRegistration
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Analytics ¶
type Analytics struct {
// contains filtered or unexported fields
}
Appends each event to a file as a line of JSON
type AnalyticsConfig ¶
type AnalyticsConfig struct {
Path string
}
type AnalyticsRegistration ¶
type AnalyticsRegistration struct{}
func (AnalyticsRegistration) Initialize ¶
func (AnalyticsRegistration) Initialize(cfgAny any, deps analytics.AnalyticsDeps) (analytics.Analytics, error)
func (AnalyticsRegistration) InitializeConfig ¶
func (AnalyticsRegistration) InitializeConfig() any
func (AnalyticsRegistration) Name ¶
func (AnalyticsRegistration) Name() string
type Authentication ¶
type Authentication struct {
AuthenticationConfig
}
Accepts requests carrying a fixed key in a header
func (*Authentication) CheckAuthentication ¶
type AuthenticationConfig ¶
type AuthenticationRegistration ¶
type AuthenticationRegistration struct{}
func (AuthenticationRegistration) Initialize ¶
func (AuthenticationRegistration) Initialize(cfgAny any, deps authentication.AuthenticationDeps) (authentication.Authentication, error)
func (AuthenticationRegistration) InitializeConfig ¶
func (AuthenticationRegistration) InitializeConfig() any
func (AuthenticationRegistration) Name ¶
func (AuthenticationRegistration) Name() string
type Cache ¶
type Cache struct {
// contains filtered or unexported fields
}
Stores tiles in a sample datastore
type CacheConfig ¶
type CacheConfig struct {
Datastore string
}
type CacheRegistration ¶
type CacheRegistration struct{}
func (CacheRegistration) Initialize ¶
func (CacheRegistration) InitializeConfig ¶
func (CacheRegistration) InitializeConfig() any
func (CacheRegistration) Name ¶
func (CacheRegistration) Name() string
type Check ¶
type Check struct {
CheckConfig
// contains filtered or unexported fields
}
Healthy while a layer can still render a tile, bypassing the cache
type CheckConfig ¶
func (CheckConfig) GetDelay ¶
func (c CheckConfig) GetDelay() uint
type CheckRegistration ¶
type CheckRegistration struct{}
func (CheckRegistration) Initialize ¶
func (CheckRegistration) Initialize(cfgAny health.HealthCheckConfig, deps health.HealthCheckDeps) (health.HealthCheck, error)
func (CheckRegistration) InitializeConfig ¶
func (CheckRegistration) InitializeConfig() health.HealthCheckConfig
func (CheckRegistration) Name ¶
func (CheckRegistration) Name() string
type Datastore ¶
type Datastore struct {
DatastoreConfig
// contains filtered or unexported fields
}
An in-memory map shared by whichever entities reference its ID. A real datastore would hold a connection pool
type DatastoreConfig ¶
type DatastoreConfig struct {
ID string
}
type DatastoreRegistration ¶
type DatastoreRegistration struct{}
func (DatastoreRegistration) Initialize ¶
func (DatastoreRegistration) Initialize(cfgAny any, deps datastore.DatastoreDeps) (datastore.DatastoreWrapper, error)
func (DatastoreRegistration) InitializeConfig ¶
func (DatastoreRegistration) InitializeConfig() any
func (DatastoreRegistration) Name ¶
func (DatastoreRegistration) Name() string
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Renders a solid color tile once at startup and serves it for every request
func (*Provider) GenerateTile ¶
func (p *Provider) GenerateTile(_ context.Context, _ layer.ProviderContext, t pkg.TileRequest) (*pkg.Image, error)
func (*Provider) PreAuth ¶
func (p *Provider) PreAuth(_ context.Context, _ layer.ProviderContext) (layer.ProviderContext, error)
type ProviderConfig ¶
type ProviderConfig struct {
Color string // Six digit hex, such as 00AA88
}
type ProviderRegistration ¶
type ProviderRegistration struct{}
func (ProviderRegistration) Initialize ¶
func (ProviderRegistration) Initialize(cfgAny any, deps layer.ProviderDeps) (layer.Provider, error)
func (ProviderRegistration) InitializeConfig ¶
func (ProviderRegistration) InitializeConfig() any
func (ProviderRegistration) Name ¶
func (ProviderRegistration) Name() string
type RateLimit ¶ added in v0.14.0
type RateLimit struct {
// contains filtered or unexported fields
}
Counts in the sample datastore. Policies, windows, and headers are handled by tilegroxy
type RateLimitStoreConfig ¶ added in v0.14.0
type RateLimitStoreConfig struct {
Datastore string
}
type RateLimitStoreRegistration ¶ added in v0.14.0
type RateLimitStoreRegistration struct{}
func (RateLimitStoreRegistration) Initialize ¶ added in v0.14.0
func (RateLimitStoreRegistration) Initialize(cfgAny any, deps ratelimit.RateLimiterDeps) (ratelimit.RateLimiter, error)
func (RateLimitStoreRegistration) InitializeConfig ¶ added in v0.14.0
func (RateLimitStoreRegistration) InitializeConfig() any
func (RateLimitStoreRegistration) Name ¶ added in v0.14.0
func (RateLimitStoreRegistration) Name() string
type Secret ¶
type Secret struct {
SecretConfig
}
type SecretConfig ¶
Holds secrets inline. A real secret source would fetch them from a vault
type SecretRegistration ¶
type SecretRegistration struct{}
func (SecretRegistration) CheckBatchSize ¶
func (SecretRegistration) CheckBatchSize() int
Zero means this source can't report changes, so secret watching can't be enabled
func (SecretRegistration) Initialize ¶
func (SecretRegistration) Initialize(cfgAny any, deps secret.SecreterDeps) (secret.Secreter, error)
func (SecretRegistration) InitializeConfig ¶
func (SecretRegistration) InitializeConfig() any
func (SecretRegistration) Name ¶
func (SecretRegistration) Name() string
Click to show internal directories.
Click to hide internal directories.