originstore

Documentation

Overview

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2016-2019 Uber Technologies, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Config
• type Store
  • func New(config Config, clk clock.Clock, origins hostlist.List, ...) Store
  • func NewNoopStore() Store

Types

type Config

type Config struct {
	LocationsTTL         time.Duration `yaml:"locations_ttl"`
	LocationsErrorTTL    time.Duration `yaml:"locations_error_ttl"`
	OriginContextTTL     time.Duration `yaml:"origin_context_ttl"`
	OriginUnavailableTTL time.Duration `yaml:"origin_unavailable_ttl"`
}

Config defines Store configuration.

type Store

type Store interface {
	// GetOrigins returns all available origins seeding d. Returns error if all origins
	// are unavailable.
	GetOrigins(d core.Digest) ([]*core.PeerInfo, error)
}

Store is a local cache in front of the origin cluster which is resilient to origin unavailability.

func New

func New(config Config, clk clock.Clock, origins hostlist.List, provider blobclient.Provider) Store

New creates a new Store.

func NewNoopStore

func NewNoopStore() Store

NewNoopStore returns a Store which never returns origins. Useful for testing.