webds

README

webds

Distributed System with websocket

设计

• 整体结构

Server层为核心服务层，通过选举产生一个中心节点.
SubServer层实例不可被选举为中心节点，但可以跨网段部署，其余与server节点等效
client层节点可以连接任意server节点
每个server节点都有维护 superior/lateral master 列表, 用以记录上级和平级的节点.
每个节点最多只有一个实际往出连通的平级或上级的连接,用以维护数据广播的最终一致性
平级连接之间共享 superior/lateral master 列表
出口连接共享 topics 1级订阅列表
出口连接当成一个特殊的入口连接, 出口连接不存在则为整个广播系统最核心的master节点,出口连接断掉则根据选举算法重新确定连接

• 通信方式

    websocket
  

• 通信协议 保留下列1级topic，其余topic用于分发 /sys 用于系统指令, 消息不广播, 用以两个节点之间连接维护状态和共享信息 /inner 用于client 连接的Server直接处理，不进行广播, 响应函数由 conn.On 函数指定 /self 用于回复消息时使用, 回复消息统一目标地址为/self/source_idx source_idx 定长 4个字节, 根据source_idx 映射表找到实际的上一跳地址 /srv 用以注册同步类型服务 暂未开发

• 命令行工具设计

    参照ros命令行设计：形如
        - webds topic list/pub/sub
        - webds node list/stop
  

• 选举步骤

  • 交换id
  • 交换信息
  • 请求是否跳转 不跳转则建立成功

TODO

• client/go/py/js

• command tools

• 分布式，选举产生中心通信节点

• 服务模式(同步消息机制)

• 消息广播机制 优化和benchmark

• 是否进行目标地址映射，减小协议编码长度

• 变量逃逸分析 是否要大量采用interface来组织代码 评估性能损失

update

• v0.2.9 更新节点发现库
• v0.2.8 更新消息解码函数，订阅函数、id生成函数，fix bugs
• v0.2.7 更新cluster选举策略， 修复一些bug
• v0.2.6 采用protobuf 重写通信协议
• v0.2.5 重新组织代码，将重要对象拆分成interface, 优化代码逻辑，完善节点选举
• v0.2.4 同级节点选举过程完成
• v0.2.3 修改了消息协议 完善分布式设计思路
• v0.2.2 修改了OnConnection的回调函数, 若回调函数返回error, 则 conn 直接关闭, 该功能可用于鉴定权限. 优化消息解析代码. 初步开始设计分布式结构.
• v0.2.1 添加webds node list/stop 指令
• v0.2.0 基于topic订阅机制初步重构完 server， go.client，command tool
• v0.1.0 old version just a websocket server

Documentation

Index

• Constants
• Variables
• func New(cfg *Config) *webds
• type Cluster
• type Config
• type Connection
• type Master
• type Webds

Constants

const (
	Version = "v0.2.9"
)

Variables

var (
	EncodeUrl = core.EncodeUrl
	DecodeUrl = core.DecodeUrl
)

var (
	ErrOrigin = errors.New("error origin")
)

Functions

func New

func New(cfg *Config) *webds

Types

type Cluster

type Cluster = core.Cluster

type Config

type Config = cfg.Config

type Connection

type Connection = core.Connection

type Master

type Master = core.Master

type Webds

type Webds = core.Webds