# README
- install go-atomos gen tool 1.1 go install github.com/hwangtou/go-atomos/protoc-gen-go-atomos
# Packages
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InitCosmosProcess 初始化进程 该函数只能被调用一次,且必须在进程启动时调用。.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewImplementationFromDeveloper 用于把开发者的实现转换成*_atomos.pb.go中的ElementImplementation实例。 For converting developer's implementation to ElementImplementation instance in *_atomos.pb.go.
NewInterfaceFromDeveloper 用于把开发者的实现转换成*_atomos.pb.go中的ElementInterface实例。 For creating ElementInterface instance in *_atomos.pb.go.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
AtomosBusy 启动成功,正在处理消息 Atom is started and busy processing message.
AtomosHalt 停止 Atom is stopped.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AtomosSpawning 启动中 Atom is starting up.
AtomosStopping 停止中 Atom is stopping.
AtomosWaiting 启动成功,等待消息 Atom is started and waiting for message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MailAsyncMessageCallback 异步信息回调邮件。.
MailHalt 终止邮件,用于停止Atomos的运行。 Stopping Mail, for stopping an atomos from running.
MailMessage 信息邮件,用于外部给运行中的Atomos传递信息。 Message Mail, for messaging to a running atomos from outer.
MailScale Scale邮件。.
MailTask 任务邮件,用于内部给运行中的Atomos新增任务。 Task Mail, for adding task to a running atomos from inner.
MailWormhole 虫洞邮件,用于传递不属于"Atomos宇宙"概念的对象。 Wormhole Mail, for transporting non-"Atomos Cosmos" object.
No description provided by the author
No description provided by the author
TaskCancelled 任务被取消。 Task is cancelled.
TaskDone 任务已经被执行。 (暂时不会用到这种状态,因为这时atomosTask已经不再存在。) Task has been done.
TaskExecuting 任务正在被执行。 (暂时不会用到这种状态,因为这时atomosTask已经不再存在。) Task is executing.
TaskMailing 任务已经被发送到Atomos邮箱,普通任务会被马上加到Atomos邮箱尾部,定时任务会在指定时间被加入到Atomos邮箱头部。 Task has been sent to Atomos Mailbox, common task will be sent to the tail of Atomos Mail immediately, timer task will be sent to the head of Atomos Mail after the timer times up.
TaskScheduling 任务正在排程,还未加入到Atomos邮箱,目前仅定时任务会使用这种状态。 Task is scheduling, and has not been sent to Atomos mailbox yet, only timer task will use this state.
# Variables
AtomosRemoteService_ServiceDesc is the grpc.ServiceDesc for AtomosRemoteService service.
Enum value maps for ClusterNodeState.
Enum value maps for ClusterNodeState.
No description provided by the author
Enum value maps for IDType.
Enum value maps for IDType.
Enum value maps for LogLevel.
Enum value maps for LogLevel.
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BaseAtomos 基础Atomos Base Atomos.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Element Broadcast.
No description provided by the author
Get Atom ID.
No description provided by the author
Get Element Info.
No description provided by the author
Get Idle Time.
No description provided by the author
Get ID State.
No description provided by the author
Kill Atom.
No description provided by the author
Scale Get Atom ID.
No description provided by the author
Spawn Atom.
No description provided by the author
Sync Messaging.
No description provided by the author
Try Killing Remote.
No description provided by the author
CosmosRunnable 是Cosmos的可运行实例,每个Atomos的可执行文件,都需要实现和提供这个对象。 CosmosRunnable is the runnable instance of Cosmos, each executable file of Atomos needs to implement and provide this object.
Try to call "Broadcast" on Element.
No description provided by the author
No description provided by the author
ElementImplementation 从*.proto文件生成到*_atomos.pb.go文件中的,ElementImplementation对象。 ElementImplementation in *_atomos.pb.go, which is generated from developer defined *.proto file.
ElementInterface 从*.proto文件生成到*_atomos.pb.go文件中的,ElementInterface对象。 ElementInterface in *_atomos.pb.go, which is generated from developer defined *.proto file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedAtomosRemoteServiceServer must be embedded to have forward compatible implementations.
# Interfaces
AtomAutoData Atom的自动持久化对象,要提供Atom数据的Getter和Setter。在Element Spawn时,会调用Getter获取数据;在Element Halt时,会调用Setter保存数据。 Atom Auto Data Persistence object, it should provide Getter and Setter of Atom data.
Atomos Atomos类型.
AtomosAcceptWormhole 接收虫洞中的内容,如果不实现,则无法正常使用ID中的SendWormhole方法。 Accept object from wormhole, if not implemented, SendWormhole method of ID will not work properly.
AtomosHolder Atomos持有者 Atomos Holder.
AtomosRecover Atomos的各种崩溃恢复的处理,如果不实现,将使用默认的处理。 Recover from various crashes of Atomos, if not implemented, default processing will be used.
AtomosRemoteServiceClient is the client API for AtomosRemoteService service.
AtomosRemoteServiceServer is the server API for AtomosRemoteService service.
AtomosUtilities Atomos的实用工具集。 Atomos Utilities.
AtomosWormhole 虫洞传送的对象 Object of Wormhole.
AtomSelfID 是Atom的SelfID。 AtomSelfID is SelfID of Atom.
AutoData 自动数据持久化的构造器,将具体的Atom自动数据持久化对象和Element自动数据持久化对象构造出来。 Auto Data Persistence Constructor, it will construct Atom Auto Data Persistence object and Element Auto Data Persistence object.
AutoDataLoader 自动数据持久化的加载器的加载方法和卸载方法,用于加载和卸载数据库的资源。 Auto Data Persistence Loader's Load and Unload method, used to load and unload database resource.
No description provided by the author
CosmosMainScript Cosmos的Main脚本,由用户实现,用于在进程启动和关闭时执行一些操作。 Main script of Cosmos, which is implemented by developer, will execute some operations when process starts and closes.
CosmosNode 是Cosmos节点的接口,每个Cosmos节点都需要实现这个接口。 CosmosNode is the interface of Cosmos node, each Cosmos node needs to implement this interface.
Element 类型 Element type
我们可以把Element理解成Atom的类型和管理器容器,类似面向对象的class和对应实例的容器管理器的概念。 两种Element类型,本地Element和远程Element。 We can think of Element as the type and manager container of Atom, similar to the concept of class and corresponding instance container manager in object-oriented.
ElementAtomExit Element中Atom的自定义退出超时时间和退出间隔时间,用于控制退出。 Element Customize Exit, used for controlling Atom kill.
ElementAtomInitNum Element的自定义Atom初始数量,用于初始化Atom的数量。 Element Customize Atom Initial Number, used for initializing Atom number.
ElementAuthorization Element的鉴权,用于检查操作是否满足权限。 Element Authorization, used for checking whether the operation meets the permission.
ElementAutoData Element的自动持久化对象,要提供Element数据的Getter和Setter。 Element Auto Data Persistence object, it should provide Getter and Setter of Element data.
ElementDeveloper 开发者实现的Element的构造器,将具体的Element对象和Atom的具体Atom对象构造出来,并在启动时传入到Atomos中。 Element Constructor of developer implements.
ElementLogLevel Element的自定义日志级别,用于控制日志输出。 Element Customize Log Level, used for controlling log output.
ElementSelfID 是Element的SelfID。 ElementSelfID is SelfID of Element.
ElementStartRunning Element的自定义启动函数,当Element启动时,启动一个新的goroutine调用该函数。 Element Start Running Function, when Element starts, it will start a new goroutine to call this function.
ElementVersion Element的自定义版本号,用于版本控制。 Element Customize Version, used for version control.
ID 是对Atomos的标识符,类似指针和句柄的概念。 ID, an instance that similar to file descriptor of the Atom.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReleasableID 可以释放的ID,每当我们成功获得一个ID之后,都应该defer Release。 ReleasableID, an ID that can be released, we should defer Release after we get an ID successfully.
SelfID 是让Atomos对象内部访问的ID的概念。 通过SelfID,Atomos内部可以访问到自己的Cosmos(CosmosProcess)、可以杀掉自己(KillSelf),以及提供Log和Task的相关功能。 SelfID is the concept of ID that can be accessed by Atomos object internally.
No description provided by the author
UnsafeAtomosRemoteServiceServer may be embedded to opt out of forward compatibility for this service.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
CosmosProcessState 进程的状态.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TaskState 任务状态 Atomos task state.