endpoints

Documentation

Index

• type Announce
• type DB
  • func NewDB() DB
  • func (db *DB) Compare(endpoints []*Ydb_Discovery.EndpointInfo) bool
  • func (db *DB) GetAll() Map
  • func (db *DB) Update(endpoints []*Ydb_Discovery.EndpointInfo) (Announce, int, int)
• type Filter
  • func NewFilter() *Filter
  • func (f *Filter) Filter(endpoints []*Ydb_Discovery.EndpointInfo) (preferred []*Ydb_Discovery.EndpointInfo, ...)
  • func (f *Filter) WithQueryService() *Filter
• type InfoShort
  • func NewInfoShort(ep *Ydb_Discovery.EndpointInfo) InfoShort
  • func NewInfoShortFromParams(location, address string, nodeID, port uint32) InfoShort
  • func (eis *InfoShort) GetAddress() string
  • func (eis *InfoShort) GetPort() uint32
• type Map
• type Prefer
• type Require

Types

type Announce

type Announce struct {
	Add    Map         // contains newly discovered endpoints
	Update Map         // contains endpoints with changes (reserved for later use with load factor)
	Del    []InfoShort // contains endpoints that are no longer present in YDB cluster
}

Announce consolidates changes observed in YDB endpoints since previous observation.

type DB

type DB struct {
	// contains filtered or unexported fields
}

DB is thread safe in-memory storage for endpoints.

func NewDB

func NewDB() DB

NewDB creates endpoints DB.

func (*DB) Compare

func (db *DB) Compare(endpoints []*Ydb_Discovery.EndpointInfo) bool

Compare takes current state of endpoints and compares it with internal endpoints Map. It returns true if incoming state is identical to internal or false otherwise.

func (*DB) GetAll

func (db *DB) GetAll() Map

GetAll returns copy of internal endpoints Map.

func (*DB) Update

func (db *DB) Update(endpoints []*Ydb_Discovery.EndpointInfo) (Announce, int, int)

Update takes current state of endpoints and - updates internal DB accordingly - constructs endpoints announcement that reflects performed changes.

type Filter

type Filter struct {
	Require *Require
	Prefer  *Prefer
}

func NewFilter

func NewFilter() *Filter

func (*Filter) Filter

func (f *Filter) Filter(endpoints []*Ydb_Discovery.EndpointInfo) (
	preferred []*Ydb_Discovery.EndpointInfo,
	notPreferred []*Ydb_Discovery.EndpointInfo,
)

func (*Filter) WithQueryService

func (f *Filter) WithQueryService() *Filter

type InfoShort

type InfoShort struct {
	Address     string
	Location    string
	AddressHash uint64
	NodeID      uint32
	Port        uint32
}

InfoShort uniquely identifies YDB endpoint.

func NewInfoShort

func NewInfoShort(ep *Ydb_Discovery.EndpointInfo) InfoShort

func NewInfoShortFromParams

func NewInfoShortFromParams(location, address string, nodeID, port uint32) InfoShort

func (*InfoShort) GetAddress

func (eis *InfoShort) GetAddress() string

func (*InfoShort) GetPort

func (eis *InfoShort) GetPort() uint32

type Map

type Map map[InfoShort]*Ydb_Discovery.EndpointInfo

Map stores endpoints as kay-value structure.

type Prefer

type Prefer struct {
	Locations []string
}

type Require

type Require struct {
	Services  []string
	Locations []string
}