C++#

基础 API#

Init

初始化客户端,根据配置连接到 openYuanrong 集群。

IsInitialized

检查是否已调用 init 接口完成初始化。

IsLocalMode

检查函数是否运行在本地模式。

Finalize

关闭客户端,释放函数实例等创建的资源。

Config 结构体

init 接口使用的配置参数。

InstanceRange 结构体

Range 调度使用的配置参数。

Exception

openYuanrong 抛出的异常。

有状态及无状态函数 API#

YR_INVOKE

注册 openYuanrong 函数。

YR_STATE

标记类的成员变量为 openYuanrong 函数的状态。

YR_RECOVER

注册有状态函数实例恢复时的回调函数。

YR_SHUTDOWN

注册有状态函数实例退出时的回调函数。

Function

构造 FunctionHandler 句柄。

FunctionHandler::Invoke

调用无状态函数。

FunctionHandler::Options

指定无状态函数调用时的配置,比如资源、亲和等。

FunctionHandler::SetUrn

指定无状态函数调用时的 URN,配合 CppFunction 或 JavaFunction 接口使用。

Instance

构造 InstanceCreator 对象。

InstanceCreator::Invoke

创建有状态函数实例。

InstanceCreator::Options

指定有状态函数实例创建时的配置项,比如资源、亲和等。

InstanceCreator::SetUrn

指定有状态函数实例创建时的 URN。

InstanceFunctionHandler::Invoke

调用有状态函数的方法。

InstanceFunctionHandler::Options

指定有状态函数方法调用时的配置项,比如重试次数等。

NamedInstance

有状态函数实例的句柄。

GetInstance

获取一个具名有状态函数实例。

Cancel

取消无状态函数或有状态函数的方法调用。

Exit

退出当前函数实例。

SaveState

保存有状态函数实例的状态。

LoadState

导入有状态函数实例的状态。

InvokeOptions 结构体

用于设置调用选项。

数据对象 API#

Put

保存数据对象到数据系统。

Get

根据数据对象的键从数据系统中检索值。

Wait

给定一组数据对象的键,等待指定数量的数据对象的值就绪。

ObjectRef

对象引用,即数据对象的键。

数据流 API#

Stream

在 openYuanrong 函数间传递共享的有序无界内存数据集。

集合通信 API#

Collective

集合通信 API 全量说明,涵盖类型定义、组管理接口与集合通信算子。

函数互调 API#

PyFunction

通过函数名称构造 FunctionHandler 句柄,用于调用 Python 无状态函数。

PyInstanceClass::FactoryCreate

构造 PyInstanceClass 对象,用于创建 Python 有状态函数实例.

JavaFunction

通过函数名称构造 FunctionHandler 句柄,用于调用 Java 无状态函数。

JavaInstanceClass FactoryCreate

构造 JavaInstanceClass 对象,用于创建 Java 有状态函数实例。

CppFunction

通过函数名称构造 FunctionHandler 句柄,用于调用 C++ 无状态函数。

CppInstanceClass FactoryCreate

构造 CppInstanceClass 对象,用于创建 C++ 有状态函数实例。

函数组 API#

Group

函数组生命周期管理接口。

KV 缓存 API#

KV().Set

存储二进制数据到数据系统,类似 Redis 的 SET 接口。

KV().MSetTx

批量存储二进制数据到数据系统,类似 Redis 的 Mset 接口。

KV().Write

写入一个键的值。

KV().MWriteTx

设置多个键值对。

KV().WriteRaw

写入键的值(原始字节)。

KV().Get

检索与指定键关联的值,类似于 Redis 的 GET 命令。

KV().GetWithParam

检索与指定键关联的多个值,并支持基于偏移量的额外参数进行读取。

KV().Read

检索键的值。

KV().ReadRaw

检索由 WriteRaw 写入的键的值。

KV().Del

删除一个键及其关联的数据,类似于 Redis 的 DEL 命令。

线程并行 API#

ParallelFor

用于多线程并行编程的 API。

亲和调度#

Affinity

亲和调度的配置参数。

设置跨语言 python 的 runtime env API#

RuntimeEnv

设置跨语言 python 的 runtime env API。