gateway

Documentation

Index

• Variables
• func PackGatewayPacket(connID string, websocketType int, data []byte) server.Packet
• type Endpoint
  • func NewEndpoint(name, address string) *Endpoint
  • func (slf *Endpoint) Connect()
  • func (slf *Endpoint) Offline()
  • func (slf *Endpoint) Write(packet server.Packet)
• type EndpointManager
  • func NewEndpointManager() *EndpointManager
  • func (slf *EndpointManager) AddEndpoint(endpoint *Endpoint) error
  • func (slf *EndpointManager) GetEndpoint(name string, conn *server.Conn) (*Endpoint, error)
  • func (slf *EndpointManager) RemoveEndpoint(endpoint *Endpoint) error
• type Gateway
  • func NewGateway(srv *server.Server, options ...Option) *Gateway
  • func (slf *Gateway) Run(addr string) error
  • func (slf *Gateway) Shutdown()
• type Option
  • func WithEndpointSelector(selector func([]*Endpoint) *Endpoint) Option
• type Packet
  • func UnpackGatewayPacket(packet server.Packet) Packet

Variables

var (
	// ErrEndpointAlreadyExists 网关端点已存在
	ErrEndpointAlreadyExists = errors.New("gateway: endpoint already exists")
	// ErrCannotAddRunningEndpoint 无法添加一个正在运行的网关端点
	ErrCannotAddRunningEndpoint = errors.New("gateway: cannot add a running endpoint")
	// ErrEndpointNotExists 该名称下不存在任何端点
	ErrEndpointNotExists = errors.New("gateway: endpoint not exists")
)

Functions

func PackGatewayPacket

func PackGatewayPacket(connID string, websocketType int, data []byte) server.Packet

PackGatewayPacket 打包网关数据包

Types

type Endpoint

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

Endpoint 网关端点

func NewEndpoint

func NewEndpoint(name, address string) *Endpoint

NewEndpoint 创建网关端点

func (*Endpoint) Connect

func (slf *Endpoint) Connect()

Connect 连接端点

func (*Endpoint) Offline

func (slf *Endpoint) Offline()

Offline 离线

func (*Endpoint) Write

func (slf *Endpoint) Write(packet server.Packet)

Write 写入数据

type EndpointManager

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

EndpointManager 网关端点管理器

func NewEndpointManager

func NewEndpointManager() *EndpointManager

NewEndpointManager 创建网关端点管理器

func (*EndpointManager) AddEndpoint

func (slf *EndpointManager) AddEndpoint(endpoint *Endpoint) error

AddEndpoint 添加端点

func (*EndpointManager) GetEndpoint

func (slf *EndpointManager) GetEndpoint(name string, conn *server.Conn) (*Endpoint, error)

GetEndpoint 获取端点

func (*EndpointManager) RemoveEndpoint

func (slf *EndpointManager) RemoveEndpoint(endpoint *Endpoint) error

RemoveEndpoint 移除端点

type Gateway

type Gateway struct {
	*EndpointManager // 端点管理器
	// contains filtered or unexported fields
}

Gateway 网关

func NewGateway

func NewGateway(srv *server.Server, options ...Option) *Gateway

NewGateway 基于 server.Server 创建网关服务器

func (*Gateway) Run

func (slf *Gateway) Run(addr string) error

Run 运行网关

func (*Gateway) Shutdown

func (slf *Gateway) Shutdown()

Shutdown 关闭网关

type Option

type Option func(gateway *Gateway)

Option 网关选项

func WithEndpointSelector

func WithEndpointSelector(selector func([]*Endpoint) *Endpoint) Option

WithEndpointSelector 设置端点选择器

• 默认情况下，网关会随机选择一个端点作为目标，如果需要自定义端点选择器，可以通过该选项设置

type Packet

type Packet struct {
	ConnID        string
	WebsocketType int
	Data          []byte
}

func UnpackGatewayPacket

func UnpackGatewayPacket(packet server.Packet) Packet

UnpackGatewayPacket 解包网关数据包