framework

package module
v0.1.50 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 21, 2024 License: LGPL-2.1 Imports: 34 Imported by: 0

README

framework

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

本框架特点如下：

...

本包提供以下插件：

  • 消息队列与事件驱动架构（MQ and Broker），基于NATS。
  • 服务发现（Service Discovery），基于Etcd或Redis。
  • 分布式锁（Distributed Sync），基于Etcd或Redis。
  • 分布式服务支持（Distributed Service），定义分布式节点地址格式，提供异步模型未来（Future），支持分布式服务间通信，可以横向拓展服务。
  • 分布式实体支持（Distributed Entities），提供分布式实体信息上报与查询功能，支持分布式实体间通信。
  • GTP协议（Golaxy Transfer Protocol），适用于长连接、实时通信的工作场景，需要工作在可靠网络协议（TCP/WebSocket）之上，支持双向签名验证、链路加密、链路鉴权、断线续连重传、自定义消息等特性。
  • GTP协议网关与客户端（GTP Gate and Client），基于TCP/WebSocket的GTP网关与客户端实现。
  • GAP协议（Golaxy Application Protocol），适用于开发应用层通信消息，需要工作在GTP协议或MQ之上，支持消息判重、自定义消息、自定义可变类型等特性。
  • 路由（Router），支持规划路线，映射网关上的会话与实体，使任意服务可以与客户端通信，还可以创建分组，支持消息组播。
  • RPC支持（Remote Procedure Call），支持服务间、实体间、或与客户端和分组间进行RPC调用，基于GAP协议，支持可变类型，整体做到了简单易用。
  • 日志（Logger），基于Zap。
  • 配置（Config），基于Viper。

Install

go get -u git.golaxy.org/framework

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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, generic any) *App

Setup 安装服务泛化类型

func (*App) StartingCB 

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

StartingCB 启动回调

func (*App) TerminateCB added in v0.1.33 

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

TerminateCB 终止回调

type IRuntimeInstantiation added in v0.1.45 

type IRuntimeInstantiation interface {
	Instantiation() runtime.Context
}

IRuntimeInstantiation 运行时实例化接口

type IServiceInstantiation added in v0.1.45 

type IServiceInstantiation interface {
	Instantiation() service.Context
}

IServiceInstantiation 服务实例化接口

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 LifecycleRuntimeBuilt added in v0.1.45 

type LifecycleRuntimeBuilt interface {
	Built(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 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 LifecycleServiceBuilt added in v0.1.45 

type LifecycleServiceBuilt interface {
	Built(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 RuntimeCreator 

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

RuntimeCreator 运行时构建器

func CreateRuntime 

func CreateRuntime(ctx service.Context) RuntimeCreator

CreateRuntime 创建运行时

func (RuntimeCreator) AutoRun 

func (c RuntimeCreator) AutoRun(auto bool) RuntimeCreator

AutoRun 自动开始运行

func (RuntimeCreator) FPS added in v0.1.27 

func (c RuntimeCreator) FPS(fps float32) RuntimeCreator

FPS 帧率

func (RuntimeCreator) Name 

func (c RuntimeCreator) Name(name string) RuntimeCreator

Name 名称

func (RuntimeCreator) PanicHandling added in v0.1.27 

func (c RuntimeCreator) PanicHandling(autoRecover bool, reportError chan error) RuntimeCreator

PanicHandling panic时的处理方式

func (RuntimeCreator) ProcessQueueCapacity 

func (c RuntimeCreator) ProcessQueueCapacity(cap int) RuntimeCreator

ProcessQueueCapacity 任务处理流水线大小

func (RuntimeCreator) Setup 

func (c RuntimeCreator) Setup(generic any) RuntimeCreator

Setup 安装运行时泛化类型

func (RuntimeCreator) Spawn 

func (c RuntimeCreator) Spawn() core.Runtime

Spawn 创建运行时

type RuntimeGeneric added in v0.1.37 

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

RuntimeGeneric 运行时泛化类型

func (*RuntimeGeneric) GetMemKVs added in v0.1.37 

func (r *RuntimeGeneric) GetMemKVs() *sync.Map

GetMemKVs 获取服务内存KV数据库

func (*RuntimeGeneric) GetServiceCtx added in v0.1.37 

func (r *RuntimeGeneric) GetServiceCtx() service.Context

GetServiceCtx 获取服务上下文

func (*RuntimeGeneric) GetStartupConf added in v0.1.37 

func (r *RuntimeGeneric) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置

type RuntimeInstance added in v0.1.45 

type RuntimeInstance struct {
	runtime.ContextBehavior
}

RuntimeInstance 运行时实例

func (*RuntimeInstance) CreateEntity added in v0.1.45 

func (instance *RuntimeInstance) CreateEntity() core.EntityCreator

CreateEntity 创建实体

func (*RuntimeInstance) GetMemKVs added in v0.1.45 

func (instance *RuntimeInstance) GetMemKVs() *sync.Map

GetMemKVs 获取服务内存KV数据库

func (*RuntimeInstance) GetStartupConf added in v0.1.45 

func (instance *RuntimeInstance) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置

type ServiceGeneric added in v0.1.37 

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

ServiceGeneric 服务泛化类型

func (*ServiceGeneric) GetName added in v0.1.37 

func (s *ServiceGeneric) GetName() string

GetName 获取服务名称

func (*ServiceGeneric) GetStartupConf added in v0.1.37 

func (s *ServiceGeneric) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置

type ServiceInstance added in v0.1.45 

type ServiceInstance struct {
	service.ContextBehavior
}

ServiceInstance 服务实例

func (*ServiceInstance) CreateEntityPT added in v0.1.45 

func (instance *ServiceInstance) CreateEntityPT() core.EntityPTCreator

CreateEntityPT 创建实体原型

func (*ServiceInstance) CreateRuntime added in v0.1.45 

func (instance *ServiceInstance) CreateRuntime() RuntimeCreator

CreateRuntime 创建运行时

func (*ServiceInstance) GetBroker added in v0.1.45 

func (instance *ServiceInstance) GetBroker() broker.IBroker

GetBroker 获取broker插件

func (*ServiceInstance) GetConf added in v0.1.45 

func (instance *ServiceInstance) GetConf() conf.IVisitConf

GetConf 获取配置插件

func (*ServiceInstance) GetDistEntityQuerier added in v0.1.45 

func (instance *ServiceInstance) GetDistEntityQuerier() dentq.IDistEntityQuerier

GetDistEntityQuerier 获取分布式实体查询插件

func (*ServiceInstance) GetDistService added in v0.1.45 

func (instance *ServiceInstance) GetDistService() dserv.IDistService

GetDistService 获取分布式服务插件

func (*ServiceInstance) GetDistSync added in v0.1.45 

func (instance *ServiceInstance) GetDistSync() dsync.IDistSync

GetDistSync 获取分布式同步插件

func (*ServiceInstance) GetMemKVs added in v0.1.45 

func (instance *ServiceInstance) GetMemKVs() *sync.Map

GetMemKVs 获取服务内存KV数据库

func (*ServiceInstance) GetRPC added in v0.1.45 

func (instance *ServiceInstance) GetRPC() rpc.IRPC

GetRPC 获取RPC支持插件

func (*ServiceInstance) GetRegistry added in v0.1.45 

func (instance *ServiceInstance) GetRegistry() discovery.IRegistry

GetRegistry 获取服务发现插件

func (*ServiceInstance) GetStartupConf added in v0.1.45 

func (instance *ServiceInstance) GetStartupConf() *viper.Viper

GetStartupConf 获取启动参数配置

func (*ServiceInstance) GetStartupIdx added in v0.1.48 

func (instance *ServiceInstance) GetStartupIdx() int

GetStartupIdx 获取启动索引

Source Files

View all Source files

Directories

Path Synopsis
net
gap
Package gap Golaxy应用层协议（golaxy application protocol），适用于开发应用层通信消息，需要工作在GTP协议或MQ之上，支持消息判重，解决了幂等性问题。
 Package gap Golaxy应用层协议（golaxy application protocol），适用于开发应用层通信消息，需要工作在GTP协议或MQ之上，支持消息判重，解决了幂等性问题。
gap/codec
gap/variant
gtp
Package gtp Golaxy传输层协议（golaxy transfer protocol），适用于长连接、实时通信的工作场景，需要工作在可靠网络协议（TCP/WebSocket）之上，支持链路加密、链路鉴权、断线续连等特性。
 Package gtp Golaxy传输层协议（golaxy transfer protocol），适用于长连接、实时通信的工作场景，需要工作在可靠网络协议（TCP/WebSocket）之上，支持链路加密、链路鉴权、断线续连等特性。
gtp/codec
gtp/method
gtp/transport
netpath
plugins
broker
broker/nats_broker
conf
dent
dentq
+k8s:deepcopy-gen=package
 +k8s:deepcopy-gen=package
discovery
+k8s:deepcopy-gen=package
 +k8s:deepcopy-gen=package
discovery/cache_discovery
discovery/etcd_discovery
discovery/redis_discovery
dserv
dsync
dsync/etcd_dsync
dsync/redis_dsync
gate
gate/cli
log
log/console_log
log/zap_log
router
rpc
rpc/callpath
rpc/processor
rpc/rpcli
rpc/rpcutil
util
binaryutil
concurrent

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.