discovery

Documentation

Index

• Constants
• type Agent
  • func NewAgent(discoveryClient client.DiscoveryClient, autoSyncInterval time.Duration) Agent
• type Event
• type EventType
• type Node
• type NodeType
• type Snapshot

Constants

const (
	// EventTypeAdd indicates that a node has been added.
	EventTypeAdd = EventType("add")

	// EventTypeDel indicates that a node has been removed.
	EventTypeDel = EventType("del")
)

const (
	// NodeTypeMaster indicates that the node is a master.
	NodeTypeMaster = NodeType("master")
	// NodeTypeExecutor indicates that the node is an executor.
	NodeTypeExecutor = NodeType("executor")
)

Types

type Agent

type Agent interface {
	Run(ctx context.Context) error
	Subscribe(ctx context.Context) (Snapshot, *notifier.Receiver[Event], error)
}

Agent registers receives membership changes of all nodes.

func NewAgent

func NewAgent(
	discoveryClient client.DiscoveryClient,
	autoSyncInterval time.Duration,
) Agent

NewAgent creates a new Agent that receives membership changes from the discovery service. autoSyncInterval is the interval to update membership with the latest information and notify subscribers.

type Event

type Event struct {
	Tp   EventType
	Node Node
}

Event is a node membership change event.

type EventType

type EventType string

EventType describes the type of the event, i.e. Add or Del.

type Node

type Node struct {
	Tp   NodeType
	ID   string
	Addr string
}

Node describes the information of a node.

type NodeType

type NodeType string

NodeType describes the type of the node.

type Snapshot

type Snapshot map[string]Node

Snapshot is the current service membership snapshot.