framework

README

framework

Golaxy分布式服务开发框架，基于Actor线程模型（Actor Model）与分布式实体（Distributed Entities）架构，可以快速开发服务器应用。

本框架特点如下：

...

本包提供以下插件：

• 消息队列与事件驱动架构（MQ and Broker），基于NATS。
• 服务发现（Service Discovery），基于Etcd或Redis。
• 分布式锁（Distributed Sync），基于Etcd或Redis。
• GTP协议（Golaxy Transfer Protocol），适用于长连接、实时通信的工作场景，需要工作在可靠网络协议（TCP/KCP）之上，支持链路加密、链路鉴权、断线续连等特性。
• GTP协议网关和客户端（GTP Gate and Client）。
• GAP协议（Golaxy Application Protocol），适用于开发应用层通信消息，需要工作在GTP协议或MQ之上，支持消息判重，解决了幂等性问题。
• 分布式服务支持（Distributed Service）。
• 分布式实体支持（Distributed Entities）。
• RPC支持（Remote Procedure Call）。
• 日志（Logger）。

Install

go get -u git.golaxy.org/framework

Documentation

Overview

Package framework Golaxy分布式服务开发框架。

Index

• type App
  • func NewApp() *App
  • func (app *App) GetStartupConf() *viper.Viper
  • func (app *App) InitCB(cb generic.DelegateAction1[*App]) *App
  • func (app *App) Run()
  • func (app *App) Setup(name string, serv any, num ...int) *App
  • func (app *App) StartingCB(cb generic.DelegateAction1[*App]) *App
  • func (app *App) StoppedCB(cb generic.DelegateAction1[*App]) *App
• type InstallRuntimeDistEntities
• type InstallRuntimeLogger
• type InstallServiceBroker
• type InstallServiceConfig
• type InstallServiceDistEntityQuerier
• type InstallServiceDistService
• type InstallServiceDistSync
• type InstallServiceLogger
• type InstallServiceRPC
• type InstallServiceRegistry
• type LifecycleRuntimeBirth
• type LifecycleRuntimeFrameLoopBegin
• type LifecycleRuntimeFrameLoopEnd
• type LifecycleRuntimeFrameUpdateBegin
• type LifecycleRuntimeFrameUpdateEnd
• type LifecycleRuntimeInit
• type LifecycleRuntimeRunCallBegin
• type LifecycleRuntimeRunCallEnd
• type LifecycleRuntimeRunGCBegin
• type LifecycleRuntimeRunGCEnd
• type LifecycleRuntimeStarted
• type LifecycleRuntimeStarting
• type LifecycleRuntimeTerminated
• type LifecycleRuntimeTerminating
• type LifecycleServiceBirth
• type LifecycleServiceInit
• type LifecycleServiceStarted
• type LifecycleServiceStarting
• type LifecycleServiceTerminated
• type LifecycleServiceTerminating
• type RuntimeBehavior
  • func (rb *RuntimeBehavior) GetMemKVs() *sync.Map
  • func (rb *RuntimeBehavior) GetServiceCtx() service.Context
  • func (rb *RuntimeBehavior) GetStartupConf() *viper.Viper
• type RuntimeCreator
  • func CreateRuntime(ctx service.Context) *RuntimeCreator
  • func (c *RuntimeCreator) AutoRun(auto bool) *RuntimeCreator
  • func (c *RuntimeCreator) ErrorHandling(autoRecover bool, reportError chan error) *RuntimeCreator
  • func (c *RuntimeCreator) Frames(fps float32, blink bool) *RuntimeCreator
  • func (c *RuntimeCreator) Name(name string) *RuntimeCreator
  • func (c *RuntimeCreator) ProcessQueueCapacity(cap int) *RuntimeCreator
  • func (c *RuntimeCreator) Setup(rt any) *RuntimeCreator
  • func (c *RuntimeCreator) Spawn() core.Runtime
• type ServiceBehavior
  • func (sb *ServiceBehavior) GetName() string
  • func (sb *ServiceBehavior) GetStartupConf() *viper.Viper

Types

type App

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

App 应用

func NewApp

func NewApp() *App

NewApp 创建应用

func (*App) GetStartupConf

func (app *App) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置

func (*App) InitCB

func (app *App) InitCB(cb generic.DelegateAction1[*App]) *App

InitCB 初始化回调

func (*App) Run

func (app *App) Run()

Run 回调

func (*App) Setup

func (app *App) Setup(name string, serv any, num ...int) *App

Setup 安装服务

func (*App) StartingCB

func (app *App) StartingCB(cb generic.DelegateAction1[*App]) *App

StartingCB 启动回调

func (*App) StoppedCB

func (app *App) StoppedCB(cb generic.DelegateAction1[*App]) *App

StoppedCB 停止回调

type InstallRuntimeDistEntities

type InstallRuntimeDistEntities interface {
	InstallDistEntities(ctx runtime.Context)
}

type InstallRuntimeLogger

type InstallRuntimeLogger interface {
	InstallLogger(ctx runtime.Context)
}

type InstallServiceBroker

type InstallServiceBroker interface {
	InstallBroker(ctx service.Context)
}

type InstallServiceConfig

type InstallServiceConfig interface {
	InstallConfig(ctx service.Context)
}

type InstallServiceDistEntityQuerier

type InstallServiceDistEntityQuerier interface {
	InstallDistEntityQuerier(ctx service.Context)
}

type InstallServiceDistService

type InstallServiceDistService interface {
	InstallDistService(ctx service.Context)
}

type InstallServiceDistSync

type InstallServiceDistSync interface {
	InstallDistSync(ctx service.Context)
}

type InstallServiceLogger

type InstallServiceLogger interface {
	InstallLogger(ctx service.Context)
}

type InstallServiceRPC

type InstallServiceRPC interface {
	InstallRPC(ctx service.Context)
}

type InstallServiceRegistry

type InstallServiceRegistry interface {
	InstallRegistry(ctx service.Context)
}

type LifecycleRuntimeBirth

type LifecycleRuntimeBirth interface {
	Birth(ctx runtime.Context)
}

type LifecycleRuntimeFrameLoopBegin

type LifecycleRuntimeFrameLoopBegin interface {
	FrameLoopBegin(ctx runtime.Context)
}

type LifecycleRuntimeFrameLoopEnd

type LifecycleRuntimeFrameLoopEnd interface {
	FrameLoopEnd(ctx runtime.Context)
}

type LifecycleRuntimeFrameUpdateBegin

type LifecycleRuntimeFrameUpdateBegin interface {
	FrameUpdateBegin(ctx runtime.Context)
}

type LifecycleRuntimeFrameUpdateEnd

type LifecycleRuntimeFrameUpdateEnd interface {
	FrameUpdateEnd(ctx runtime.Context)
}

type LifecycleRuntimeInit

type LifecycleRuntimeInit interface {
	Init(ctx runtime.Context)
}

type LifecycleRuntimeRunCallBegin

type LifecycleRuntimeRunCallBegin interface {
	RunCallBegin(ctx runtime.Context)
}

type LifecycleRuntimeRunCallEnd

type LifecycleRuntimeRunCallEnd interface {
	RunCallEnd(ctx runtime.Context)
}

type LifecycleRuntimeRunGCBegin

type LifecycleRuntimeRunGCBegin interface {
	RunGCBegin(ctx runtime.Context)
}

type LifecycleRuntimeRunGCEnd

type LifecycleRuntimeRunGCEnd interface {
	RunGCEnd(ctx runtime.Context)
}

type LifecycleRuntimeStarted

type LifecycleRuntimeStarted interface {
	Started(ctx runtime.Context)
}

type LifecycleRuntimeStarting

type LifecycleRuntimeStarting interface {
	Starting(ctx runtime.Context)
}

type LifecycleRuntimeTerminated

type LifecycleRuntimeTerminated interface {
	Terminated(ctx runtime.Context)
}

type LifecycleRuntimeTerminating

type LifecycleRuntimeTerminating interface {
	Terminating(ctx runtime.Context)
}

type LifecycleServiceBirth

type LifecycleServiceBirth interface {
	Birth(ctx service.Context)
}

type LifecycleServiceInit

type LifecycleServiceInit interface {
	Init(ctx service.Context)
}

type LifecycleServiceStarted

type LifecycleServiceStarted interface {
	Started(ctx service.Context)
}

type LifecycleServiceStarting

type LifecycleServiceStarting interface {
	Starting(ctx service.Context)
}

type LifecycleServiceTerminated

type LifecycleServiceTerminated interface {
	Terminated(ctx service.Context)
}

type LifecycleServiceTerminating

type LifecycleServiceTerminating interface {
	Terminating(ctx service.Context)
}

type RuntimeBehavior

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

func (*RuntimeBehavior) GetMemKVs

func (rb *RuntimeBehavior) GetMemKVs() *sync.Map

func (*RuntimeBehavior) GetServiceCtx

func (rb *RuntimeBehavior) GetServiceCtx() service.Context

func (*RuntimeBehavior) GetStartupConf

func (rb *RuntimeBehavior) GetStartupConf() *viper.Viper

type RuntimeCreator

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

func CreateRuntime

func CreateRuntime(ctx service.Context) *RuntimeCreator

func (*RuntimeCreator) AutoRun

func (c *RuntimeCreator) AutoRun(auto bool) *RuntimeCreator

func (*RuntimeCreator) ErrorHandling

func (c *RuntimeCreator) ErrorHandling(autoRecover bool, reportError chan error) *RuntimeCreator

func (*RuntimeCreator) Frames

func (c *RuntimeCreator) Frames(fps float32, blink bool) *RuntimeCreator

func (*RuntimeCreator) Name

func (c *RuntimeCreator) Name(name string) *RuntimeCreator

func (*RuntimeCreator) ProcessQueueCapacity

func (c *RuntimeCreator) ProcessQueueCapacity(cap int) *RuntimeCreator

func (*RuntimeCreator) Setup

func (c *RuntimeCreator) Setup(rt any) *RuntimeCreator

func (*RuntimeCreator) Spawn

func (c *RuntimeCreator) Spawn() core.Runtime

type ServiceBehavior

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

ServiceBehavior 服务行为，在开发新服务时，匿名嵌入至服务结构体中

func (*ServiceBehavior) GetName

func (sb *ServiceBehavior) GetName() string

GetName 获取服务名称

func (*ServiceBehavior) GetStartupConf

func (sb *ServiceBehavior) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置