package api

import "github.com/coreos/etcd/etcdserver/api"

Package api manages the capabilities and features that are exposed to clients by the etcd cluster.

Index

Functions

func EnableCapability

func EnableCapability(c Capability)

func IsCapabilityEnabled

func IsCapabilityEnabled(c Capability) bool

func UpdateCapability

func UpdateCapability(v *semver.Version)

UpdateCapability updates the enabledMap when the cluster version increases.

Types

type Capability

type Capability string
const (
	AuthCapability  Capability = "auth"
	V3rpcCapability Capability = "v3rpc"
)

type Cluster

type Cluster interface {
	// ID returns the cluster ID
	ID() types.ID
	// ClientURLs returns an aggregate set of all URLs on which this
	// cluster is listening for client requests
	ClientURLs() []string
	// Members returns a slice of members sorted by their ID
	Members() []*membership.Member
	// Member retrieves a particular member based on ID, or nil if the
	// member does not exist in the cluster
	Member(id types.ID) *membership.Member
	// IsIDRemoved checks whether the given ID has been removed from this
	// cluster at some point in the past
	IsIDRemoved(id types.ID) bool
	// Version is the cluster-wide minimum major.minor version.
	Version() *semver.Version
}

Cluster is an interface representing a collection of members in one etcd cluster.

Source Files

capability.go cluster.go doc.go

Directories

PathSynopsis
etcdserver/api/v2httpPackage v2http provides etcd client and server implementations.
etcdserver/api/v2http/httptypesPackage httptypes defines how etcd's HTTP API entities are serialized to and deserialized from JSON.
etcdserver/api/v3clientPackage v3client provides clientv3 interfaces from an etcdserver.
etcdserver/api/v3electionPackage v3election provides a v3 election service from an etcdserver.
etcdserver/api/v3election/v3electionpbPackage v3electionpb is a generated protocol buffer package.
etcdserver/api/v3election/v3electionpb/gwPackage v3electionpb is a reverse proxy.
etcdserver/api/v3lockPackage v3lock provides a v3 locking service from an etcdserver.
etcdserver/api/v3lock/v3lockpbPackage v3lockpb is a generated protocol buffer package.
etcdserver/api/v3lock/v3lockpb/gwPackage v3lockpb is a reverse proxy.
etcdserver/api/v3rpcPackage v3rpc implements etcd v3 RPC system based on gRPC.
etcdserver/api/v3rpc/rpctypesPackage rpctypes has types and values shared by the etcd server and client for v3 RPC interaction.
Version
v3.2.3+incompatible
Published
Jul 13, 2017
Platform
js/wasm
Imports
6 packages
Last checked
2 hours ago

Tools for package owners.