eve::statepatch::StatePatch类 参考

Script module factory for generic state patch stores. 更多...

#include <StatePatch.h>

类 eve::statepatch::StatePatch 继承关系图:

Public 成员函数
	Module_REG (StatePatch)
	StatePatch ()=default
	Constructs a StatePatch.
	~StatePatch () override
	Withdraw world-state capability listeners before owned stores are destroyed.
Public 成员函数 继承自 eve::Module
virtual	~Module ()
	Module.
virtual std::string	getName () const =0
	Returns the name.

静态 Public 成员函数
static eve::Result< StateStoreHandleRef >	newStore ()
	Allocates a state store and returns its ownership reference.
static eve::script::Borrowed< Store >	resolve (StateStoreHandleRef reference) noexcept
	Resolves a live store as a non-owning observation.
static eve::Result< void >	release (StateStoreHandleRef reference)
	Releases a module-owned state store.
static bool	isStale (StateStoreHandleRef reference) noexcept
	Reports whether a store reference is stale for the current module.
static eve::script::Borrowed< PatchBatch >	resolveBatch (StateBatchHandleRef reference) noexcept
	Resolves a store-qualified batch as a non-owning observation.
static eve::Result< void >	releaseBatch (StateBatchHandleRef reference)
	Releases a store-qualified patch batch.
static bool	isBatchStale (StateBatchHandleRef reference) noexcept
	Reports whether a store-qualified batch reference is stale.

详细描述

Script module factory for generic state patch stores.

在文件 StatePatch.h 第 272 行定义.

构造及析构函数说明

StatePatch()

eve::statepatch::StatePatch::StatePatch ( )

default

Constructs a StatePatch.

~StatePatch()

eve::statepatch::StatePatch::~StatePatch ( )

override

Withdraw world-state capability listeners before owned stores are destroyed.

在文件 StatePatch.cpp 第 641 行定义.

引用了 adapter.

成员函数说明

isBatchStale()

bool eve::statepatch::StatePatch::isBatchStale ( StateBatchHandleRef  reference )

staticnoexcept

Reports whether a store-qualified batch reference is stale.

在文件 StatePatch.cpp 第 698 行定义.

引用了 isBatchStale() , 以及 reference.

被这些函数引用 isBatchStale().

isStale()

bool eve::statepatch::StatePatch::isStale ( StateStoreHandleRef  reference )

staticnoexcept

Reports whether a store reference is stale for the current module.

在文件 StatePatch.cpp 第 723 行定义.

引用了 reference.

Module_REG()

eve::statepatch::StatePatch::Module_REG

(

StatePatch

)

newStore()

eve::Result< StateStoreHandleRef > eve::statepatch::StatePatch::newStore ( )

static

Allocates a state store and returns its ownership reference.

返回

A generation-qualified reference; the current StatePatch module owns the store.

备注

The reference becomes stale after release, module unload, or reload. Each live store is also registered as an IStateQuery / IStateMutation listener so dialogue and other consumers can discover it via cap::.

在文件 StatePatch.cpp 第 667 行定义.

引用了 eve::Applied, created, eve::Status::success() , 以及 eve::Result< T >::success().

release()

eve::Result< void > eve::statepatch::StatePatch::release ( StateStoreHandleRef  reference )

static

Releases a module-owned state store.

在文件 StatePatch.cpp 第 712 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure() , 以及 eve::StaleHandle.

releaseBatch()

eve::Result< void > eve::statepatch::StatePatch::releaseBatch ( StateBatchHandleRef  reference )

static

Releases a store-qualified patch batch.

在文件 StatePatch.cpp 第 685 行定义.

引用了 eve::Diagnostic::error(), eve::Result< T >::failure(), reference , 以及 eve::StaleHandle.

resolve()

eve::script::Borrowed< Store > eve::statepatch::StatePatch::resolve ( StateStoreHandleRef  reference )

staticnoexcept

Resolves a live store as a non-owning observation.

在文件 StatePatch.cpp 第 706 行定义.

resolveBatch()

eve::script::Borrowed< PatchBatch > eve::statepatch::StatePatch::resolveBatch ( StateBatchHandleRef  reference )

staticnoexcept

Resolves a store-qualified batch as a non-owning observation.

在文件 StatePatch.cpp 第 677 行定义.

引用了 reference , 以及 resolveBatch().

被这些函数引用 resolveBatch().

---

该类的文档由以下文件生成:

• src/modules/statepatch/StatePatch.h
• src/modules/statepatch/StatePatch.cpp