topology

type DynamicOptions interface {
	// Validate validates the options
	Validate() error

	// SetConfigServiceClient sets the client of ConfigService
	SetConfigServiceClient(c client.Client) DynamicOptions

	// ConfigServiceClient returns the client of ConfigService
	ConfigServiceClient() client.Client

	// SetServiceID sets the ServiceID for service discovery
	SetServiceID(s services.ServiceID) DynamicOptions

	// ServiceID returns the ServiceID for service discovery
	ServiceID() services.ServiceID

	// SetServicesOverrideOptions sets the override options for service discovery.
	SetServicesOverrideOptions(opts services.OverrideOptions) DynamicOptions

	// ServicesOverrideOptions returns the override options for service discovery.
	ServicesOverrideOptions() services.OverrideOptions

	// SetQueryOptions sets the ConfigService query options
	SetQueryOptions(value services.QueryOptions) DynamicOptions

	// QueryOptions returns the ConfigService query options
	QueryOptions() services.QueryOptions

	// SetInstrumentOptions sets the instrumentation options
	SetInstrumentOptions(value utils.Options) DynamicOptions

	// InstrumentOptions returns the instrumentation options
	InstrumentOptions() utils.Options
}

type DynamicTopology interface {
	Topology

	// MarkShardsAvailable marks a shard with the state of initializing as available
	MarkShardsAvailable(instanceID string, shardIDs ...uint32) error
}

type HealthTrackingDynamicTopoloy interface {
	Topology

	// MarkHostHealthy will keep the host in the view of Hosts
	MarkHostHealthy(host Host) error
	// MarkHostUnhealthy will remove the host from the view of Hosts
	MarkHostUnhealthy(host Host) error
}

type Host interface {
	// ID is the identifier of the host
	ID() string

	// Address returns the address of the host
	Address() string

	// String returns a string representation of the host
	String() string
}

type HostID string

type HostShardConfig struct {
	HostID        string `yaml:"hostID"`
	ListenAddress string `yaml:"listenAddress"`
}

type HostShardSet interface {
	// Host returns the host
	Host() Host

	// ShardSet returns the shard set owned by the host
	ShardSet() shard.ShardSet
}

type HostShardState struct {
	Host       Host
	ShardState m3Shard.State
}

type Initializer interface {
	// Init will return a new topology
	Init() (Topology, error)

	// TopologyIsSet returns whether the topology is able to be
	// initialized immediately or if instead it will blocked
	// wait to be set on initialization
	TopologyIsSet() (bool, error)
}

type Map interface {
	// Hosts returns all hosts in the map
	Hosts() []Host

	// HostShardSets returns all HostShardSets in the map
	HostShardSets() []HostShardSet

	// LookupHostShardSet returns a HostShardSet for a host in the map
	LookupHostShardSet(hostID string) (HostShardSet, bool)

	// HostsLen returns the length of all hosts in the map
	HostsLen() int

	// ShardSet returns the shard set for the topology
	ShardSet() shard.ShardSet

	// RouteShard will route a given shard to a set of hosts
	RouteShard(shard uint32) ([]Host, error)

	// Replicas returns the number of replicas in the topology
	Replicas() int
}

type MapProvider interface {
	// TopologyMap returns a topology map.
	TopologyMap() (Map, error)
}

type MapWatch interface {
	// WatchChan is a notification channel when a value becomes available
	C() <-chan struct{}

	// Get the current placement map
	Get() Map

	// Close the watch on the placement map
	Close()
}

type ShardID int

type ShardOwner interface {
	GetOwnedShards() []int
}

type ShardStates map[ShardID]map[HostID]HostShardState

type StateSnapshot struct {
	ShardStates ShardStates
}

type StaticConfiguration struct {
	Shards   int               `yaml:"shards"`
	Replicas int               `yaml:"replicas"`
	Hosts    []HostShardConfig `yaml:"hosts"`
}

type StaticOptions interface {
	// Validate validates the options
	Validate() error

	// SetShardSet sets the ShardSet
	SetShardSet(value shard.ShardSet) StaticOptions

	// ShardSet returns the ShardSet
	ShardSet() shard.ShardSet

	// SetHostShardSets sets the hostShardSets
	SetHostShardSets(value []HostShardSet) StaticOptions

	// HostShardSets returns the hostShardSets
	HostShardSets() []HostShardSet

	// SetReplicas sets the replicas
	SetReplicas(value int) StaticOptions

	// Replicas returns the replicas
	Replicas() int
}

type Topology interface {
	// Get the placement setting map
	Get() Map

	// Watch for the placement setting map
	Watch() (MapWatch, error)

	// Close will close the placement setting map
	Close()
}