framework

package module
v0.3.57 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2025 License: LGPL-2.1 Imports: 50 Imported by: 6

README

Framework

English | 简体中文

Introduction

Golaxy Distributed Service Development Framework aims to provide a comprehensive server-side solution for real-time communication applications. Based on the core of the EC system and Actor thread model, the framework implements all dependency functions for distributed services. It is designed to be simple and easy to use, making it particularly suitable for developing games and remote control systems.

Features

The framework supports the development of stateful (Stateful) or stateless (Stateless) distributed services with the following features:

  • MQ and Broker: Based on NATS, supports message queue and event-driven architecture.
  • Service Discovery: Based on ETCD, also supports Redis (for demo purposes due to lack of data version control).
  • Distributed Synchronization: Supports distributed locking with ETCD or Redis, default is ETCD.
  • Distributed Service: Defines distributed service node address format, provides asynchronous model futures (Future), supports inter-service communication and horizontal scaling.
  • Distributed Entities: Provides registration and query functions for distributed entities, supports communication between them.
  • GTP Protocol: For long connections and real-time communication, works on reliable protocols (TCP/WebSocket), supports bi-directional signature verification, link encryption, link authentication, reconnect and retransmission, custom messages.
  • GAP Protocol: For application layer communication messages, works on GTP Protocol or MQ, supports message deduplication, custom messages, custom variable types.
  • GTP Gate and Client: Gateway and client based on GTP Protocol, supports TCP/WebSocket long connections.
  • Router: Supports communication routing, session to entity mapping, client-service communication, communication grouping, and multicast messages.
  • RPC: Supports RPC calls between services, entities, clients, and groups based on GAP Protocol, supports variable types, simple and easy to use. Supports one-way notification RPC and response RPC.
  • Logger: Based on Zap.
  • Config: Based on Viper, supports local and remote configurations.
  • Database: Supports connection to relational databases (based on GORM), Redis, MongoDB.

Directory

Directory Description
/ Common types and functions for application development.
/addins/broker Message queue middleware.
/addins/conf Configuration system.
/addins/db Database support.
/addins/dentq Distributed entity query support.
/addins/dentr Distributed entity registration support.
/addins/discovery Service discovery.
/addins/dsvc Distributed service support.
/addins/dsync Distributed locking.
/addins/gate GTP gateway implementation.
/addins/log Logging system.
/addins/router Client routing system.
/addins/rpc RPC system.
/addins/rpcstack RPC stack support.
/net/gap GAP protocol implementation.
/net/gtp GTP protocol implementation.
/net/netpath Service node address structure.
/utils Various utility classes and functions.

Examples

See: Examples

Installation

go get -u git.golaxy.org/framework

Associated Repositories

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source 
var BuildEntityPT = core.BuildEntityPT

BuildEntityPT 创建实体原型

View Source 
var (
	ErrEntityOrComponentNotLiving = errors.New("async/await: entity or component not living")
)
View Source 
var (
	ErrFramework = errors.New("framework") // 框架错误
)

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) GetStartupCmd added in v0.3.44 

func (app *App) GetStartupCmd() *cobra.Command

GetStartupCmd 获取启动命令

func (*App) GetStartupConf 

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

GetStartupConf 获取启动参数配置

func (*App) InitCB 

func (app *App) InitCB(cb generic.Action1[*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.Action1[*App]) *App

StartingCB 启动回调

func (*App) TerminateCB added in v0.1.33 

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

TerminateCB 终止回调

type AwaitDirector added in v0.1.56 

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

AwaitDirector 异步等待分发器

func (AwaitDirector) All added in v0.1.56 

func (ad AwaitDirector) All(fun generic.FuncVar1[[]async.Ret, any, async.Ret], args ...any) async.AsyncRet

All 异步等待所有结果返回，有返回值

func (AwaitDirector) AllVoid added in v0.3.12 

func (ad AwaitDirector) AllVoid(fun generic.ActionVar1[[]async.Ret, any], args ...any) async.AsyncRet

AllVoid 异步等待所有结果返回，无返回值

func (AwaitDirector) Any added in v0.1.56 

func (ad AwaitDirector) Any(fun generic.FuncVar1[async.Ret, any, async.Ret], args ...any) async.AsyncRet

Any 异步等待任意一个结果返回，有返回值

func (AwaitDirector) AnyVoid added in v0.3.12 

func (ad AwaitDirector) AnyVoid(fun generic.ActionVar1[async.Ret, any], args ...any) async.AsyncRet

AnyVoid 异步等待任意一个结果返回，无返回值

func (AwaitDirector) Foreach added in v0.3.12 

func (ad AwaitDirector) Foreach(fun generic.ActionVar1[async.Ret, any], args ...any) async.AsyncRet

Foreach 异步等待产出（yield）返回

func (AwaitDirector) OK added in v0.3.12 

func (ad AwaitDirector) OK(fun generic.FuncVar1[async.Ret, any, async.Ret], args ...any) async.AsyncRet

OK 异步等待任意一个结果成功返回，有返回值

func (AwaitDirector) OKVoid added in v0.3.12 

func (ad AwaitDirector) OKVoid(fun generic.ActionVar1[async.Ret, any], args ...any) async.AsyncRet

OKVoid 异步等待任意一个结果成功返回，无返回值

func (AwaitDirector) Transform added in v0.3.12 

func (ad AwaitDirector) Transform(fun generic.FuncVar1[async.Ret, any, async.Ret], args ...any) async.AsyncRet

Transform 异步等待产出（yield）返回，并变换结果

type ComponentBehavior added in v0.1.56 

type ComponentBehavior struct {
	ec.ComponentBehavior
}

ComponentBehavior 组件行为，在开发新组件时，匿名嵌入至组件结构体中

func (*ComponentBehavior) Await added in v0.1.56 

func (c *ComponentBehavior) Await(asyncRets ...async.AsyncRet) AwaitDirector

Await 异步等待结果返回

func (*ComponentBehavior) BalanceOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) BalanceOnewayRPC(service, comp, method string, args ...any) error

BalanceOnewayRPC 使用负载均衡模式，向分布式实体目标服务发送单向RPC

func (*ComponentBehavior) BalanceRPC added in v0.1.56 

func (c *ComponentBehavior) BalanceRPC(service, comp, method string, args ...any) async.AsyncRet

BalanceRPC 使用负载均衡模式，向分布式实体目标服务发送RPC

func (*ComponentBehavior) BroadcastCliOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) BroadcastCliOnewayRPC(proc, method string, args ...any) error

BroadcastCliOnewayRPC 向包含实体的所有分组发送单向RPC

func (*ComponentBehavior) BroadcastOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) BroadcastOnewayRPC(excludeSelf bool, service, comp, method string, args ...any) error

BroadcastOnewayRPC 使用广播模式，向分布式实体目标服务发送单向RPC

func (*ComponentBehavior) CallAsync added in v0.3.5 

func (c *ComponentBehavior) CallAsync(fun generic.FuncVar0[any, async.Ret], args ...any) async.AsyncRet

CallAsync 异步执行代码，有返回值

func (*ComponentBehavior) CallVoidAsync added in v0.3.5 

func (c *ComponentBehavior) CallVoidAsync(fun generic.ActionVar0[any], args ...any) async.AsyncRet

CallVoidAsync 异步执行代码，无返回值

func (*ComponentBehavior) CliOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) CliOnewayRPC(proc, method string, args ...any) error

CliOnewayRPC 向客户端发送单向RPC

func (*ComponentBehavior) CliRPC added in v0.1.56 

func (c *ComponentBehavior) CliRPC(proc, method string, args ...any) async.AsyncRet

CliRPC 向客户端发送RPC

func (*ComponentBehavior) GetAddInManager added in v0.2.81 

func (c *ComponentBehavior) GetAddInManager() extension.AddInManager

GetAddInManager 获取插件管理器

func (*ComponentBehavior) GetLiving added in v0.3.12 

func (c *ComponentBehavior) GetLiving() bool

GetLiving 是否活跃可用

func (*ComponentBehavior) GetRuntime added in v0.1.56 

func (c *ComponentBehavior) GetRuntime() IRuntime

GetRuntime 获取运行时

func (*ComponentBehavior) GetService added in v0.1.56 

func (c *ComponentBehavior) GetService() IService

GetService 获取服务

func (*ComponentBehavior) GlobalBalanceOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) GlobalBalanceOnewayRPC(excludeSelf bool, comp, method string, args ...any) error

GlobalBalanceOnewayRPC 使用全局负载均衡模式，向分布式实体任意服务发送单向RPC

func (*ComponentBehavior) GlobalBalanceRPC added in v0.1.56 

func (c *ComponentBehavior) GlobalBalanceRPC(excludeSelf bool, comp, method string, args ...any) async.AsyncRet

GlobalBalanceRPC 使用全局负载均衡模式，向分布式实体任意服务发送RPC

func (*ComponentBehavior) GlobalBroadcastOnewayRPC added in v0.2.38 

func (c *ComponentBehavior) GlobalBroadcastOnewayRPC(excludeSelf bool, comp, method string, args ...any) error

GlobalBroadcastOnewayRPC 使用全局广播模式，向分布式实体所有服务发送单向RPC

func (*ComponentBehavior) GoAsync added in v0.3.5 

func (c *ComponentBehavior) GoAsync(fun generic.FuncVar0[any, async.Ret], args ...any) async.AsyncRet

GoAsync 使用新线程执行代码，有返回值（注意线程安全）

func (*ComponentBehavior) GoVoidAsync added in v0.3.5 

func (c *ComponentBehavior) GoVoidAsync(fun generic.ActionVar0[any], args ...any) async.AsyncRet

GoVoidAsync 使用新线程执行代码，无返回值（注意线程安全）

func (*ComponentBehavior) OnewayRPC added in v0.2.38 

func (c *ComponentBehavior) OnewayRPC(service, comp, method string, args ...any) error

OnewayRPC 向分布式实体目标服务发送单向RPC

func (*ComponentBehavior) RPC added in v0.1.56 

func (c *ComponentBehavior) RPC(service, comp, method string, args ...any) async.AsyncRet

RPC 向分布式实体目标服务发送RPC

func (*ComponentBehavior) ReadChanAsync added in v0.3.12 

func (c *ComponentBehavior) ReadChanAsync(ch <-chan any) async.AsyncRet

ReadChanAsync 读取channel

func (*ComponentBehavior) TimeAfterAsync added in v0.3.5 

func (c *ComponentBehavior) TimeAfterAsync(dur time.Duration) async.AsyncRet

TimeAfterAsync 定时器，指定时长

func (*ComponentBehavior) TimeAtAsync added in v0.3.5 

func (c *ComponentBehavior) TimeAtAsync(at time.Time) async.AsyncRet

TimeAtAsync 定时器，指定时间点

func (*ComponentBehavior) TimeTickAsync added in v0.3.5 

func (c *ComponentBehavior) TimeTickAsync(dur time.Duration) async.AsyncRet

TimeTickAsync 心跳器

type EntityBehavior added in v0.1.76 

type EntityBehavior struct {
	ec.EntityBehavior
}

EntityBehavior 实体行为，在需要扩展实体能力时，匿名嵌入至实体结构体中

func (*EntityBehavior) Await added in v0.1.76 

func (e *EntityBehavior) Await(asyncRets ...async.AsyncRet) AwaitDirector

Await 异步等待结果返回

func (*EntityBehavior) BalanceOnewayRPC added in v0.2.38 

func (e *EntityBehavior) BalanceOnewayRPC(service, comp, method string, args ...any) error

BalanceOnewayRPC 使用负载均衡模式，向分布式实体目标服务发送单向RPC

func (*EntityBehavior) BalanceRPC added in v0.1.76 

func (e *EntityBehavior) BalanceRPC(service, comp, method string, args ...any) async.AsyncRet

BalanceRPC 使用负载均衡模式，向分布式实体目标服务发送RPC

func (*EntityBehavior) BroadcastCliOnewayRPC added in v0.2.38 

func (e *EntityBehavior) BroadcastCliOnewayRPC(proc, method string, args ...any) error

BroadcastCliOnewayRPC 向包含实体的所有分组发送单向RPC

func (*EntityBehavior) BroadcastOnewayRPC added in v0.2.38 

func (e *EntityBehavior) BroadcastOnewayRPC(excludeSelf bool, service, comp, method string, args ...any) error

BroadcastOnewayRPC 使用广播模式，向分布式实体目标服务发送单向RPC

func (*EntityBehavior) CallAsync added in v0.3.5 

func (e *EntityBehavior) CallAsync(fun generic.FuncVar0[any, async.Ret], args ...any) async.AsyncRet

CallAsync 异步执行代码，有返回值

func (*EntityBehavior) CallVoidAsync added in v0.3.5 

func (e *EntityBehavior) CallVoidAsync(fun generic.ActionVar0[any], args ...any) async.AsyncRet

CallVoidAsync 异步执行代码，无返回值

func (*EntityBehavior) CliOnewayRPC added in v0.2.38 

func (e *EntityBehavior) CliOnewayRPC(proc, method string, args ...any) error

CliOnewayRPC 向客户端发送单向RPC

func (*EntityBehavior) CliRPC added in v0.1.76 

func (e *EntityBehavior) CliRPC(proc, method string, args ...any) async.AsyncRet

CliRPC 向客户端发送RPC

func (*EntityBehavior) GetAddInManager added in v0.2.81 

func (e *EntityBehavior) GetAddInManager() extension.AddInManager

GetAddInManager 获取插件管理器

func (*EntityBehavior) GetLiving added in v0.3.12 

func (e *EntityBehavior) GetLiving() bool

GetLiving 是否活跃可用

func (*EntityBehavior) GetRuntime added in v0.1.76 

func (e *EntityBehavior) GetRuntime() IRuntime

GetRuntime 获取运行时

func (*EntityBehavior) GetService added in v0.1.76 

func (e *EntityBehavior) GetService() IService

GetService 获取服务

func (*EntityBehavior) GlobalBalanceOnewayRPC added in v0.2.38 

func (e *EntityBehavior) GlobalBalanceOnewayRPC(excludeSelf bool, comp, method string, args ...any) error

GlobalBalanceOnewayRPC 使用全局负载均衡模式，向分布式实体任意服务发送单向RPC

func (*EntityBehavior) GlobalBalanceRPC added in v0.1.76 

func (e *EntityBehavior) GlobalBalanceRPC(excludeSelf bool, comp, method string, args ...any) async.AsyncRet

GlobalBalanceRPC 使用全局负载均衡模式，向分布式实体任意服务发送RPC

func (*EntityBehavior) GlobalBroadcastOnewayRPC added in v0.2.38 

func (e *EntityBehavior) GlobalBroadcastOnewayRPC(excludeSelf bool, comp, method string, args ...any) error

GlobalBroadcastOnewayRPC 使用全局广播模式，向分布式实体所有服务发送单向RPC

func (*EntityBehavior) GoAsync added in v0.3.5 

func (e *EntityBehavior) GoAsync(fun generic.FuncVar0[any, async.Ret], args ...any) async.AsyncRet

GoAsync 使用新线程执行代码，有返回值（注意线程安全）

func (*EntityBehavior) GoVoidAsync added in v0.3.5 

func (e *EntityBehavior) GoVoidAsync(fun generic.ActionVar0[any], args ...any) async.AsyncRet

GoVoidAsync 使用新线程执行代码，无返回值（注意线程安全）

func (*EntityBehavior) OnewayRPC added in v0.2.38 

func (e *EntityBehavior) OnewayRPC(service, comp, method string, args ...any) error

OnewayRPC 向分布式实体目标服务发送单向RPC

func (*EntityBehavior) RPC added in v0.1.76 

func (e *EntityBehavior) RPC(service, comp, method string, args ...any) async.AsyncRet

RPC 向分布式实体目标服务发送RPC

func (*EntityBehavior) ReadChanAsync added in v0.3.12 

func (e *EntityBehavior) ReadChanAsync(ch <-chan any) async.AsyncRet

ReadChanAsync 读取channel

func (*EntityBehavior) TimeAfterAsync added in v0.3.5 

func (e *EntityBehavior) TimeAfterAsync(dur time.Duration) async.AsyncRet

TimeAfterAsync 定时器，指定时长

func (*EntityBehavior) TimeAtAsync added in v0.3.5 

func (e *EntityBehavior) TimeAtAsync(at time.Time) async.AsyncRet

TimeAtAsync 定时器，指定时间点

func (*EntityBehavior) TimeTickAsync added in v0.3.5 

func (e *EntityBehavior) TimeTickAsync(dur time.Duration) async.AsyncRet

TimeTickAsync 心跳器

type EntityCreatorAsync added in v0.3.2 

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

EntityCreatorAsync 实体构建器

func BuildEntityAsync added in v0.3.12 

func BuildEntityAsync(svcCtx service.Context, prototype string) *EntityCreatorAsync

BuildEntityAsync 创建实体

func (*EntityCreatorAsync) AssignMeta added in v0.3.35 

func (c *EntityCreatorAsync) AssignMeta(m meta.Meta) *EntityCreatorAsync

AssignMeta 赋值Meta信息

func (*EntityCreatorAsync) MergeMeta added in v0.3.35 

func (c *EntityCreatorAsync) MergeMeta(dict map[string]any) *EntityCreatorAsync

MergeMeta 合并Meta信息，如果存在则覆盖

func (*EntityCreatorAsync) MergeMetaIfAbsent added in v0.3.35 

func (c *EntityCreatorAsync) MergeMetaIfAbsent(dict map[string]any) *EntityCreatorAsync

MergeMetaIfAbsent 合并Meta信息，如果存在则跳过

func (*EntityCreatorAsync) New added in v0.3.12 

func (c *EntityCreatorAsync) New() (ec.ConcurrentEntity, error)

New 创建实体

func (*EntityCreatorAsync) NewAsync added in v0.3.12 

func (c *EntityCreatorAsync) NewAsync() async.AsyncRetT[ec.ConcurrentEntity]

NewAsync 创建实体

func (*EntityCreatorAsync) SetComponentAwakeOnFirstTouch added in v0.3.12 

func (c *EntityCreatorAsync) SetComponentAwakeOnFirstTouch(b bool) *EntityCreatorAsync

SetComponentAwakeOnFirstTouch 设置开启组件被首次访问时，检测并调用Awake()

func (*EntityCreatorAsync) SetComponentNameIndexing added in v0.3.12 

func (c *EntityCreatorAsync) SetComponentNameIndexing(b bool) *EntityCreatorAsync

SetComponentNameIndexing 设置是否开启组件名称索引

func (*EntityCreatorAsync) SetComponentUniqueID added in v0.3.12 

func (c *EntityCreatorAsync) SetComponentUniqueID(b bool) *EntityCreatorAsync

SetComponentUniqueID 设置开启组件唯一Id

func (*EntityCreatorAsync) SetInstance added in v0.3.12 

func (c *EntityCreatorAsync) SetInstance(instance ec.Entity) *EntityCreatorAsync

SetInstance 设置实例，用于扩展实体能力

func (*EntityCreatorAsync) SetInstanceFace added in v0.3.12 

func (c *EntityCreatorAsync) SetInstanceFace(face iface.Face[ec.Entity]) *EntityCreatorAsync

SetInstanceFace 设置实例，用于扩展实体能力

func (*EntityCreatorAsync) SetMeta added in v0.3.12 

func (c *EntityCreatorAsync) SetMeta(dict map[string]any) *EntityCreatorAsync

SetMeta 设置Meta信息

func (*EntityCreatorAsync) SetParentId added in v0.3.12 

func (c *EntityCreatorAsync) SetParentId(id uid.Id) *EntityCreatorAsync

SetParentId 设置父实体Id

func (*EntityCreatorAsync) SetPersistId added in v0.3.12 

func (c *EntityCreatorAsync) SetPersistId(id uid.Id) *EntityCreatorAsync

SetPersistId 设置实体持久化Id

func (*EntityCreatorAsync) SetRuntime added in v0.3.12 

func (c *EntityCreatorAsync) SetRuntime(rtInst IRuntime) *EntityCreatorAsync

SetRuntime 设置运行时（优先使用）

func (*EntityCreatorAsync) SetRuntimeCreator added in v0.3.12 

func (c *EntityCreatorAsync) SetRuntimeCreator(rtCreator *RuntimeCreator) *EntityCreatorAsync

SetRuntimeCreator 设置运行时构建器

func (*EntityCreatorAsync) SetScope added in v0.3.12 

func (c *EntityCreatorAsync) SetScope(scope ec.Scope) *EntityCreatorAsync

SetScope 设置实体的可访问作用域

type EntityPTCreator added in v0.1.77 

type EntityPTCreator = core.EntityPTCreator

EntityPTCreator 实体原型构建器

type IRuntime added in v0.3.24 

type IRuntime interface {
	runtime.Context
	// GetDistEntityRegistry 获取分布式实体注册支持
	GetDistEntityRegistry() dentr.IDistEntityRegistry
	// GetRPCStack 获取RPC调用堆栈支持
	GetRPCStack() rpcstack.IRPCStack
	// GetService 获取服务实例
	GetService() IService
	// GetAutoInjection 是否自动注入组件
	GetAutoInjection() bool
	// BuildEntity 创建实体
	BuildEntity(prototype string) *core.EntityCreator
}

IRuntime 运行时实例接口

func GetRuntime added in v0.3.24 

func GetRuntime(provider runtime.CurrentContextProvider) IRuntime

GetRuntime 获取运行时实例

type IRuntimeInstantiation added in v0.1.45 

type IRuntimeInstantiation interface {
	Instantiate() IRuntime
}

IRuntimeInstantiation 运行时实例化接口

type IService added in v0.3.24 

type IService interface {
	service.Context
	// GetAppConf 获取当前应用程序配置
	GetAppConf() *viper.Viper
	// GetServiceConf 获取当前服务配置
	GetServiceConf() *viper.Viper
	// GetRegistry 获取服务发现插件
	GetRegistry() discovery.IRegistry
	// GetBroker 获取消息队列中间件插件
	GetBroker() broker.IBroker
	// GetDistSync 获取分布式同步插件
	GetDistSync() dsync.IDistSync
	// GetDistService 获取分布式服务插件
	GetDistService() dsvc.IDistService
	// GetDistEntityQuerier 获取分布式实体查询插件
	GetDistEntityQuerier() dentq.IDistEntityQuerier
	// GetRPC 获取RPC支持插件
	GetRPC() rpc.IRPC
	// GetStartupNo 获取启动序号
	GetStartupNo() int
	// GetMemory 获取服务内存KV存储
	GetMemory() *sync.Map
	// BuildRuntime 创建运行时
	BuildRuntime() *RuntimeCreator
	// BuildEntityPT 创建实体原型
	BuildEntityPT(prototype string) *EntityPTCreator
	// BuildEntityAsync 创建实体
	BuildEntityAsync(prototype string) *EntityCreatorAsync
}

IService 服务实例接口

func GetService added in v0.3.24 

func GetService(provider runtime.ConcurrentContextProvider) IService

GetService 获取服务实例

type IServiceInstantiation added in v0.1.45 

type IServiceInstantiation interface {
	Instantiate() IService
}

IServiceInstantiation 服务实例化接口

type InstallRuntimeDistEntityRegistry added in v0.1.87 

type InstallRuntimeDistEntityRegistry interface {
	InstallDistEntityRegistry(rt IRuntime)
}

type InstallRuntimeLogger 

type InstallRuntimeLogger interface {
	InstallLogger(rt IRuntime)
}

type InstallRuntimeRPCStack added in v0.1.69 

type InstallRuntimeRPCStack interface {
	InstallRPCStack(rt IRuntime)
}

type InstallServiceBroker 

type InstallServiceBroker interface {
	InstallBroker(svc IService)
}

type InstallServiceConfig 

type InstallServiceConfig interface {
	InstallConfig(svc IService)
}

type InstallServiceDistEntityQuerier 

type InstallServiceDistEntityQuerier interface {
	InstallDistEntityQuerier(svc IService)
}

type InstallServiceDistService 

type InstallServiceDistService interface {
	InstallDistService(svc IService)
}

type InstallServiceDistSync 

type InstallServiceDistSync interface {
	InstallDistSync(svc IService)
}

type InstallServiceLogger 

type InstallServiceLogger interface {
	InstallLogger(svc IService)
}

type InstallServiceRPC 

type InstallServiceRPC interface {
	InstallRPC(svc IService)
}

type InstallServiceRegistry 

type InstallServiceRegistry interface {
	InstallRegistry(svc IService)
}

type LifecycleRuntimeAddInActivated added in v0.2.85 

type LifecycleRuntimeAddInActivated interface {
	AddInActivated(rt IRuntime, addIn extension.AddInStatus)
}

type LifecycleRuntimeAddInActivating added in v0.2.85 

type LifecycleRuntimeAddInActivating interface {
	AddInActivating(rt IRuntime, addIn extension.AddInStatus)
}

type LifecycleRuntimeAddInDeactivated added in v0.2.85 

type LifecycleRuntimeAddInDeactivated interface {
	AddInDeactivated(rt IRuntime, addIn extension.AddInStatus)
}

type LifecycleRuntimeAddInDeactivating added in v0.2.85 

type LifecycleRuntimeAddInDeactivating interface {
	AddInDeactivating(rt IRuntime, addIn extension.AddInStatus)
}

type LifecycleRuntimeBirth 

type LifecycleRuntimeBirth interface {
	Birth(rt IRuntime)
}

type LifecycleRuntimeBuilt added in v0.1.45 

type LifecycleRuntimeBuilt interface {
	Built(rt IRuntime)
}

type LifecycleRuntimeFrameLoopBegin 

type LifecycleRuntimeFrameLoopBegin interface {
	FrameLoopBegin(rt IRuntime)
}

type LifecycleRuntimeFrameLoopEnd 

type LifecycleRuntimeFrameLoopEnd interface {
	FrameLoopEnd(rt IRuntime)
}

type LifecycleRuntimeFrameUpdateBegin 

type LifecycleRuntimeFrameUpdateBegin interface {
	FrameUpdateBegin(rt IRuntime)
}

type LifecycleRuntimeFrameUpdateEnd 

type LifecycleRuntimeFrameUpdateEnd interface {
	FrameUpdateEnd(rt IRuntime)
}

type LifecycleRuntimeRunCallBegin 

type LifecycleRuntimeRunCallBegin interface {
	RunCallBegin(rt IRuntime)
}

type LifecycleRuntimeRunCallEnd 

type LifecycleRuntimeRunCallEnd interface {
	RunCallEnd(rt IRuntime)
}

type LifecycleRuntimeRunGCBegin 

type LifecycleRuntimeRunGCBegin interface {
	RunGCBegin(rt IRuntime)
}

type LifecycleRuntimeRunGCEnd 

type LifecycleRuntimeRunGCEnd interface {
	RunGCEnd(rt IRuntime)
}

type LifecycleRuntimeStarted 

type LifecycleRuntimeStarted interface {
	Started(rt IRuntime)
}

type LifecycleRuntimeStarting 

type LifecycleRuntimeStarting interface {
	Starting(rt IRuntime)
}

type LifecycleRuntimeTerminated 

type LifecycleRuntimeTerminated interface {
	Terminated(rt IRuntime)
}

type LifecycleRuntimeTerminating 

type LifecycleRuntimeTerminating interface {
	Terminating(rt IRuntime)
}

type LifecycleServiceAddInActivated added in v0.2.85 

type LifecycleServiceAddInActivated interface {
	AddInActivated(svc IService, addIn extension.AddInStatus)
}

type LifecycleServiceAddInActivating added in v0.2.85 

type LifecycleServiceAddInActivating interface {
	AddInActivating(svc IService, addIn extension.AddInStatus)
}

type LifecycleServiceAddInDeactivated added in v0.2.85 

type LifecycleServiceAddInDeactivated interface {
	AddInDeactivated(svc IService, addIn extension.AddInStatus)
}

type LifecycleServiceAddInDeactivating added in v0.2.85 

type LifecycleServiceAddInDeactivating interface {
	AddInDeactivating(svc IService, addIn extension.AddInStatus)
}

type LifecycleServiceBirth 

type LifecycleServiceBirth interface {
	Birth(svc IService)
}

type LifecycleServiceBuilt added in v0.1.45 

type LifecycleServiceBuilt interface {
	Built(svc IService)
}

type LifecycleServiceDefaultConfig added in v0.3.44 

type LifecycleServiceDefaultConfig interface {
	DefaultConfig(svc IService) map[string]any
}

type LifecycleServiceEntityPTDeclared added in v0.2.85 

type LifecycleServiceEntityPTDeclared interface {
	EntityPTDeclared(svc IService, entityPT ec.EntityPT)
}

type LifecycleServiceEntityPTRedeclared added in v0.2.85 

type LifecycleServiceEntityPTRedeclared interface {
	EntityPTRedeclared(svc IService, entityPT ec.EntityPT)
}

type LifecycleServiceEntityPTUndeclared added in v0.2.85 

type LifecycleServiceEntityPTUndeclared interface {
	EntityPTUndeclared(svc IService, entityPT ec.EntityPT)
}

type LifecycleServiceStarted 

type LifecycleServiceStarted interface {
	Started(svc IService)
}

type LifecycleServiceStarting 

type LifecycleServiceStarting interface {
	Starting(svc IService)
}

type LifecycleServiceTerminated 

type LifecycleServiceTerminated interface {
	Terminated(svc IService)
}

type LifecycleServiceTerminating 

type LifecycleServiceTerminating interface {
	Terminating(svc IService)
}

type RuntimeBehavior 

type RuntimeBehavior struct {
	runtime.ContextBehavior
	// contains filtered or unexported fields
}

RuntimeBehavior 运行时实例行为

func (*RuntimeBehavior) BuildEntity added in v0.3.53 

func (rt *RuntimeBehavior) BuildEntity(prototype string) *core.EntityCreator

BuildEntity 创建实体

func (*RuntimeBehavior) GetAutoInjection added in v0.3.53 

func (rt *RuntimeBehavior) GetAutoInjection() bool

GetAutoInjection 是否自动注入组件

func (*RuntimeBehavior) GetDistEntityRegistry added in v0.3.53 

func (rt *RuntimeBehavior) GetDistEntityRegistry() dentr.IDistEntityRegistry

GetDistEntityRegistry 获取分布式实体注册支持

func (*RuntimeBehavior) GetRPCStack added in v0.3.53 

func (rt *RuntimeBehavior) GetRPCStack() rpcstack.IRPCStack

GetRPCStack 获取RPC调用堆栈支持

func (*RuntimeBehavior) GetService added in v0.3.53 

func (rt *RuntimeBehavior) GetService() IService

GetService 获取服务

type RuntimeCreator 

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

RuntimeCreator 运行时构建器

func BuildRuntime added in v0.3.12 

func BuildRuntime(svcCtx service.Context) *RuntimeCreator

BuildRuntime 创建运行时

func (*RuntimeCreator) New added in v0.3.12 

func (c *RuntimeCreator) New() IRuntime

New 创建运行时

func (*RuntimeCreator) SetAutoInjection added in v0.3.24 

func (c *RuntimeCreator) SetAutoInjection(b bool) *RuntimeCreator

SetAutoInjection 设置是否自动注入依赖的组件

func (*RuntimeCreator) SetFPS added in v0.3.12 

func (c *RuntimeCreator) SetFPS(fps float32) *RuntimeCreator

SetFPS 设置帧率

func (*RuntimeCreator) SetName added in v0.3.12 

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

SetName 设置名称

func (*RuntimeCreator) SetPanicHandling added in v0.3.12 

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

SetPanicHandling 设置panic时的处理方式

func (*RuntimeCreator) SetPersistId added in v0.3.12 

func (c *RuntimeCreator) SetPersistId(id uid.Id) *RuntimeCreator

SetPersistId 设置持久化Id

func (*RuntimeCreator) SetProcessQueueCapacity added in v0.3.12 

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

SetProcessQueueCapacity 设置任务处理流水线大小

func (*RuntimeCreator) Setup 

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

Setup 安装运行时泛化类型

type RuntimeGeneric added in v0.1.37 

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

RuntimeGeneric 运行时泛化类型

func (*RuntimeGeneric) GetService added in v0.1.87 

func (r *RuntimeGeneric) GetService() IService

GetService 获取服务

type ServiceBehavior 

type ServiceBehavior struct {
	service.ContextBehavior
	// contains filtered or unexported fields
}

ServiceBehavior 服务实例行为

func (*ServiceBehavior) BuildEntityAsync added in v0.3.53 

func (svc *ServiceBehavior) BuildEntityAsync(prototype string) *EntityCreatorAsync

BuildEntityAsync 创建实体

func (*ServiceBehavior) BuildEntityPT added in v0.3.53 

func (svc *ServiceBehavior) BuildEntityPT(prototype string) *EntityPTCreator

BuildEntityPT 创建实体原型

func (*ServiceBehavior) BuildRuntime added in v0.3.53 

func (svc *ServiceBehavior) BuildRuntime() *RuntimeCreator

BuildRuntime 创建运行时

func (*ServiceBehavior) GetAppConf added in v0.3.53 

func (svc *ServiceBehavior) GetAppConf() *viper.Viper

GetAppConf 获取当前应用程序配置

func (*ServiceBehavior) GetBroker added in v0.3.53 

func (svc *ServiceBehavior) GetBroker() broker.IBroker

GetBroker 获取消息队列中间件插件

func (*ServiceBehavior) GetDistEntityQuerier added in v0.3.53 

func (svc *ServiceBehavior) GetDistEntityQuerier() dentq.IDistEntityQuerier

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

func (*ServiceBehavior) GetDistService added in v0.3.53 

func (svc *ServiceBehavior) GetDistService() dsvc.IDistService

GetDistService 获取分布式服务插件

func (*ServiceBehavior) GetDistSync added in v0.3.53 

func (svc *ServiceBehavior) GetDistSync() dsync.IDistSync

GetDistSync 获取分布式同步插件

func (*ServiceBehavior) GetMemory added in v0.3.53 

func (svc *ServiceBehavior) GetMemory() *sync.Map

GetMemory 获取服务内存KV存储

func (*ServiceBehavior) GetRPC added in v0.3.53 

func (svc *ServiceBehavior) GetRPC() rpc.IRPC

GetRPC 获取RPC支持插件

func (*ServiceBehavior) GetRegistry added in v0.3.53 

func (svc *ServiceBehavior) GetRegistry() discovery.IRegistry

GetRegistry 获取服务发现插件

func (*ServiceBehavior) GetServiceConf added in v0.3.53 

func (svc *ServiceBehavior) GetServiceConf() *viper.Viper

GetServiceConf 获取当前服务配置

func (*ServiceBehavior) GetStartupNo added in v0.3.53 

func (svc *ServiceBehavior) GetStartupNo() int

GetStartupNo 获取启动序号

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) GetStartupCmd added in v0.3.44 

func (s *ServiceGeneric) GetStartupCmd() *cobra.Command

GetStartupCmd 获取启动命令

func (*ServiceGeneric) GetStartupConf added in v0.1.37 

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

GetStartupConf 获取启动参数配置

Source Files

View all Source files

Directories

Path Synopsis
addins
broker
broker/nats_broker
conf
db
db/dbtypes
db/mongodb
db/redisdb
db/sqldb
dentq
dentr
discovery
discovery/cache_discovery
discovery/etcd_discovery
discovery/redis_discovery
dsvc
dsync
dsync/etcd_dsync
dsync/redis_dsync
gate
gate/cli
log
log/console_log
log/zap_log
router
rpc
rpc/callpath
rpc/rpcli
rpc/rpcpcsr
rpcstack
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/sign
gtp/transport
netpath
utils
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.