urpc（高性能rpc通信库）

导入模块

import { urpc } from '@kit.RemoteCommunicationKit';

FlowbufType

type FlowbufType =

'INT8' | 'UINT8' | 'INT16' | 'UINT16' | 'INT32' | 'UINT32' | 'INT64' | 'UINT64' | 'BOOL' | 'FLOAT' | 'DOUBLE' | 'STRING' | 'BYTES' | 'MESSAGE' | 'REPEATED_INT8' | 'REPEATED_UINT8' | 'REPEATED_INT16' | 'REPEATED_UINT16' | 'REPEATED_INT32' | 'REPEATED_UINT32' | 'REPEATED_INT64' | 'REPEATED_UINT64' | 'REPEATED_BOOL' | 'REPEATED_FLOAT' | 'REPEATED_DOUBLE' | 'REPEATED_STRING' | 'REPEATED_BYTES' | 'REPEATED_MESSAGE' | 'ARRAY_INT8' | 'ARRAY_UINT8' | 'ARRAY_INT16' | 'ARRAY_UINT16' | 'ARRAY_INT32' | 'ARRAY_UINT32' | 'ARRAY_INT64' | 'ARRAY_UINT64' | 'ARRAY_BOOL' | 'ARRAY_FLOAT' | 'ARRAY_DOUBLE'

表示通过URPC通信允许传入和接收返回值的类型。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

FlowbufElement<T>

FlowbufElement<T>用于定义非数组的URPC入参和返回值类型。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

示例：

import { urpc } from '@kit.RemoteCommunicationKit';

let version: urpc.FlowbufElement<number> = {type: 'INT8', value: 0, name: ''};

FlowbufArrayElement<T>

FlowbufArrayElement<T>用于定义数组类型的URPC入参和返回值类型。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

示例：

import { urpc } from '@kit.RemoteCommunicationKit';

let version: urpc.FlowbufArrayElement<number> = {type: 'ARRAY_INT8', value: [1,2,3], length: 3};

urpcStubCreate

urpcStubCreate(config: UrpcInitConfiguration, funcList: string | string[]): Promise<UrpcStub>

创建UrpcStub，使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

需要权限： ohos.permission.INTERNET

起始版本： 5.0.1(13)

参数：

返回值：

错误码：

错误码的详细介绍请参见API错误码。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { urpc } from '@kit.RemoteCommunicationKit';

// 下面IP地址仅作为示意
let node: urpc.IpAndPort = {
  ip: '192.168.1.1',
  port: 8000
}
let connect: urpc.UrpcConnectConfiguration = {
  node: node,
  protocol: 'eat',
}
let config: urpc.UrpcInitConfiguration = {
  timeout: 3000,
  mode: 'client',
  connect: connect
}

const funcList:string[] = ['uploadFile'];
urpc.urpcStubCreate(config, funcList).then((urpcStub: urpc.UrpcStub) => {
  urpcStub.destroy();
}).catch((err: BusinessError<string>) => {
  console.error(`Failed to create urpc stub, error code ${err.code}, error info ${err.data}`);
})

UrpcCall

type UrpcCall = (funcName: string, request: object, returnValue: object, config?: CallingOption) => UrpcPromise

用于发起一个URPC请求，并接收来自服务器的响应。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

参数：

返回值：

错误码： 错误码的详细介绍请参见API错误码。

UrpcCancel

type UrpcCancel = (callingId?: number | number[]) => void

用于取消指定或所有正在进行的URPC请求。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

参数：

错误码： 错误码的详细介绍请参见API错误码。

UrpcDestroy

type UrpcDestroy = () => void

用于销毁UrpcStub实例。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

错误码： 错误码的详细介绍请参见API错误码。

UrpcStub

表示可用于发出URPC请求的通信会话。它提供了各种远程调用方法（call、cancel、destroy）。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

属性：

UrpcInitConfiguration

定义会话的配置参数，为开发者提供了对HTTP会话各个方面的详细控制。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

示例：

import { urpc } from '@kit.RemoteCommunicationKit';

// 下面IP地址仅作为示意
let node: urpc.IpAndPort = {
  ip: '192.168.1.1',
  port: 8000
}
let connect: urpc.UrpcConnectConfiguration = {
  node: node,
  protocol: 'eat',
}
let config: urpc.UrpcInitConfiguration = {
  timeout: 3000,
  mode: 'client',
  connect: connect
}

UrpcMode

type UrpcMode = 'client'

当前仅支持填写'client'，表示该URPC节点为client模式，可主动发起请求，等待服务器的响应。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

UrpcConnectConfiguration

UrpcConnectConfiguration配置URPC连接的关键信息，可以配置连接的ip和端口号，以及传输协议等可选参数。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

示例：

import { urpc } from '@kit.RemoteCommunicationKit';

// 下面IP地址仅作为示意
let node: urpc.IpAndPort = {
  ip: '192.168.1.1',
  port: 8000
}
let connect: urpc.UrpcConnectConfiguration = {
  node: node,
  protocol: 'eat',
  multiPath: false,
  flags: 0,
  host: '192.168.1.1',
  caPath: 'data/single_urpc/eat.pem'
}

IpAndPort

IpAndPort用于配置URPC的连接IP和端口号。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

示例：

import { urpc } from '@kit.RemoteCommunicationKit';

// 下面IP地址仅作为示意
let node: urpc.IpAndPort = {
  ip: '192.168.1.1',
  port: 8000
}

UrpcPromise

表示URPC请求的返回值

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

UrpcProtocol

type UrpcProtocol = 'eat'

当前仅支持填写'eat'，表示URPC的协议类型为eat。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)

CallingOption

用于配置URPC请求的优先级。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Collaboration.RemoteCommunication

起始版本： 5.0.1(13)