node

README

node

a nodes ring for a key to get node

Build

• 

Get Node Methods

Direct

dierct to get last added node, node's wight is unavailable

Consistent hashing

WIKI

Random

to get the node by random

Usage

// Node params for a node
type Node struct {
	// for recognize node with input id
	ID string
	// node's probability weight
	Weight uint32
	// node's value
	Value string
	// kvs for meta data
	Metadata config.Options

	number uint32
}

// Manager node manager functions defines.
type Manager interface {
	// adds a node to the node ring.
	Add(node *Node)
	// get the node responsible for the data key.
	NodeFor(keys ...string) (*Node, bool)
	// removes all nodes from the node ring.
	Remove()
	// removes a node from the node ring.
	RemoveByID(id string)
	// print all nodes
	PrintNodes()
	// is the node ring empty
	IsEmpty() bool
}

New a node manager

	directNode, _ := node.New(node.NodeTypeDirect, "direct")
	randomNode, _ := node.New(node.NodeTypeRandom, "random")
	consistentNode, _ := node.New(node.NodeTypeConsistent, "consistent")
	roundrobinNode, _ := node.New(node.NodeTypeRoundRobin, "roundrobin")

Or

	directNode, _ := node.NewDirect("direct")
	randomNode, _ := node.NewRandom("random")
	consistentNode, _ := node.NewConsistent("consistent")
	roundrobinNode, _ := node.NewRoundRobin("roundrobin")

Documentation

Index

• func NewNodes(cfg config.Config) (ms map[string]Manager, err error)
• func NewNodesFromConfig(filepath string) (map[string]Manager, error)
• type Manager
  • func New(nt Type, name string) (Manager, error)
  • func NewConsistent(name string) (Manager, error)
  • func NewDirect(name string) (Manager, error)
  • func NewRadmon(name string) (Manager, error)
  • func NewRoundRobin(name string) (Manager, error)
• type Node
• type Type

Functions

func NewNodes

func NewNodes(cfg config.Config) (ms map[string]Manager, err error)

NewNodes 增加Nodes节点

func NewNodesFromConfig

func NewNodesFromConfig(filepath string) (map[string]Manager, error)

NewNodesFromConfig 同步配置文件

Types

type Manager

type Manager interface {
	// adds a node to the node ring.
	Add(node *Node)
	// get the node responsible for the data key.
	NodeFor(keys ...string) (*Node, bool)
	// removes all nodes from the node ring.
	Remove()
	// removes a node from the node ring.
	RemoveByID(id string)
	// print all nodes
	PrintNodes()
	// is the node ring empty
	IsEmpty() bool
}

Manager node manager functions defines.

func New

func New(nt Type, name string) (Manager, error)

New get node manager by node type

func NewConsistent

func NewConsistent(name string) (Manager, error)

NewConsistent get consistent node manager

func NewDirect

func NewDirect(name string) (Manager, error)

NewDirect get direct node manager

func NewRadmon

func NewRadmon(name string) (Manager, error)

NewRadmon get random node manager

func NewRoundRobin

func NewRoundRobin(name string) (Manager, error)

NewRoundRobin get roundrobin node manager

type Node

type Node struct {
	// for recognize node with input id
	ID string `yaml:"id" json:"id"`
	// node's probability weight, roundrobin does not support
	Weight uint32 `yaml:"weight" json:"weight"`
	// node's value
	Value string `yaml:"value" json:"value"`
	// kvs for meta data
	Metadata config.Options `yaml:"options" json:"options"`
	// contains filtered or unexported fields
}

Node params for a node

type Type

type Type uint8

Type define node type

const (
	NodeTypeDirect Type = iota
	NodeTypeRandom
	NodeTypeConsistent
	NodeTypeRoundRobin
)

NodeType