@ohos.rpc (RPC通信)

本模块提供进程间通信能力，包括设备内的进程间通信（IPC）和设备间的进程间通信（RPC），前者基于Binder驱动，后者基于软总线驱动。

说明：

• 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块从API version 9开始支持异常返回功能。

导入模块

import rpc from '@ohos.rpc';

ErrorCode⁹⁺

从API version 9起，IPC支持异常返回功能。错误码对应数值及含义如下。

系统能力：SystemCapability.Communication.IPC.Core

MessageSequence⁹⁺

在RPC或IPC过程中，发送方可以使用MessageSequence提供的写方法，将待发送的数据以特定格式写入该对象。接收方可以使用MessageSequence提供的读方法从该对象中读取特定格式的数据。数据格式包括：基础类型及数组、IPC对象、接口描述符和自定义序列化对象。

create

static create(): MessageSequence

静态方法，创建MessageSequence对象。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageSequence.create();
hilog.info(0x0000, 'testTag', 'RpcClient: data is ' + data);

reclaim

reclaim(): void

释放不再使用的MessageSequence对象。

系统能力：SystemCapability.Communication.IPC.Core

示例：

let reply = rpc.MessageSequence.create();
reply.reclaim();

writeRemoteObject

writeRemoteObject(object: IRemoteObject): void

序列化远程对象并将其写入MessageSequence对象。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }
}
let data = rpc.MessageSequence.create();
let testRemoteObject = new TestRemoteObject("testObject");
try {
  data.writeRemoteObject(testRemoteObject);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'Rpc write remote object fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'Rpc write remote object fail, errorMessage ' + e.message);
}

readRemoteObject

readRemoteObject(): IRemoteObject

从MessageSequence读取远程对象。此方法用于反序列化MessageSequence对象以生成IRemoteObject。远程对象按写入MessageSequence的顺序读取。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }
}
let data = rpc.MessageSequence.create();
let testRemoteObject = new TestRemoteObject("testObject");
try {
  data.writeRemoteObject(testRemoteObject);
  let proxy = data.readRemoteObject();
  hilog.info(0x0000, 'testTag', 'RpcClient: readRemoteObject is ' + proxy);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'Rpc write remote object fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'Rpc write remote object fail, errorMessage ' + e.message);
}

writeInterfaceToken

writeInterfaceToken(token: string): void

将接口描述符写入MessageSequence对象，远端对象可使用该信息校验本次通信。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeInterfaceToken("aaa");
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write interface fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write interface fail, errorMessage ' + e.message);
}

readInterfaceToken

readInterfaceToken(): string

从MessageSequence对象中读取接口描述符，接口描述符按写入MessageSequence的顺序读取，本地对象可使用该信息检验本次通信。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class Stub extends rpc.RemoteObject {
  onRemoteMessageRequest(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption): boolean | Promise<boolean> {
    try {
      let interfaceToken = data.readInterfaceToken();
      hilog.info(0x0000, 'testTag', 'RpcServer: interfaceToken is ' + interfaceToken);
    } catch (error) {
      let e: BusinessError = error as BusinessError;
      hilog.error(0x0000, 'testTag', 'RpcServer: read interfaceToken failed, errorCode ' + e.code);
      hilog.error(0x0000, 'testTag', 'RpcServer: read interfaceToken failed, errorMessage ' + e.message);
    }
    return true;
  }
}

getSize

getSize(): number

获取当前创建的MessageSequence对象的数据大小。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageSequence.create();
let size = data.getSize();
hilog.info(0x0000, 'testTag', 'RpcClient: size is ' + size);

getCapacity

getCapacity(): number

获取当前MessageSequence对象的容量大小。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageSequence.create();
let result = data.getCapacity();
hilog.info(0x0000, 'testTag', 'RpcClient: capacity is ' + result);

setSize

setSize(size: number): void

设置MessageSequence对象中包含的数据大小。

系统能力：SystemCapability.Communication.IPC.Core

参数：

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
data.writeString('Hello World');
try {
  data.setSize(16);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc set size of MessageSequence fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc set size of MessageSequence fail, errorMessage ' + e.message);
}

setCapacity

setCapacity(size: number): void

设置MessageSequence对象的存储容量。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.setCapacity(100);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc memory alloc fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc memory alloc fail, errorMessage ' + e.message);
}

getWritableBytes

getWritableBytes(): number

获取MessageSequence的可写字节空间大小。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class Stub extends rpc.RemoteObject {
  onRemoteMessageRequest(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption): boolean | Promise<boolean> {
    let getWritableBytes = data.getWritableBytes();
    hilog.info(0x0000, 'testTag', 'RpcServer: getWritableBytes is ' + getWritableBytes);
    return true;
  }
}

getReadableBytes

getReadableBytes(): number

获取MessageSequence的可读字节空间。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class Stub extends rpc.RemoteObject {
  onRemoteMessageRequest(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption): boolean | Promise<boolean> {
    let result = data.getReadableBytes();
    hilog.info(0x0000, 'testTag', 'RpcServer: getReadableBytes is ' + result);
    return true;
  }
}

getReadPosition

getReadPosition(): number

获取MessageSequence的读位置。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageSequence.create();
let readPos = data.getReadPosition();
hilog.info(0x0000, 'testTag', 'RpcClient: readPos is ' + readPos);

getWritePosition

getWritePosition(): number

获取MessageSequence的写位置。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageSequence.create();
data.writeInt(10);
let bwPos = data.getWritePosition();
hilog.info(0x0000, 'testTag', 'RpcClient: bwPos is ' + bwPos);

rewindRead

rewindRead(pos: number): void

重新偏移读取位置到指定的位置。

系统能力：SystemCapability.Communication.IPC.Core

参数：

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
data.writeInt(12);
data.writeString("sequence");
let number = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: number is ' + number);
try {
  data.rewindRead(0);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc rewind read data fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc rewind read data fail, errorMessage ' + e.message);
}
let number2 = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: rewindRead is ' + number2);

rewindWrite

rewindWrite(pos: number): void

重新偏移写位置到指定的位置。

系统能力：SystemCapability.Communication.IPC.Core

参数：

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
data.writeInt(4);
try {
  data.rewindWrite(0);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc rewindWrite fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc rewindWrite fail, errorMessage ' + e.message);
}
data.writeInt(5);
let number = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: rewindWrite is: ' + number);

writeByte

writeByte(val: number): void

将字节值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeByte(2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write byte fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write byte fail, errorMessage ' + e.message);
}

readByte

readByte(): number

从MessageSequence实例读取字节值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeByte(2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write byte fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write byte fail, errorMessage ' + e.message);
}
try {
  let ret = data.readByte();
  hilog.info(0x0000, 'testTag', 'RpcClient: readByte is: ' +  ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read byte fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read byte fail, errorMessage ' + e.message);
}

writeShort

writeShort(val: number): void

将短整数值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeShort(8);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write short fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write short fail, errorMessage ' + e.message);
}

readShort

readShort(): number

从MessageSequence实例读取短整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeShort(8);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write short fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write short fail, errorMessage ' + e.message);
}
try {
  let ret = data.readShort();
  hilog.info(0x0000, 'testTag', 'RpcClient: readByte is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read short fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read short fail, errorMessage ' + e.message);
}

writeInt

writeInt(val: number): void

将整数值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeInt(10);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write int fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write int fail, errorMessage ' + e.message);
}

readInt

readInt(): number

从MessageSequence实例读取整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeInt(10);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write int fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write int fail, errorMessage ' + e.message);
}
try {
  let ret = data.readInt();
  hilog.info(0x0000, 'testTag', 'RpcClient: readInt is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read int fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read int fail, errorMessage ' + e.message);
}

writeLong

writeLong(val: number): void

将长整数值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeLong(10000);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write long fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write long fail, errorMessage ' + e.message);
}

readLong

readLong(): number

从MessageSequence实例中读取长整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeLong(10000);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write long fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write long fail, errorMessage ' + e.message);
}
try {
  let ret = data.readLong();
  hilog.info(0x0000, 'testTag', 'RpcClient: readLong is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read long fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read long fail, errorMessage ' + e.message);
}

writeFloat

writeFloat(val: number): void

将浮点值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeFloat(1.2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write float fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write float fail, errorMessage ' + e.message);
}

readFloat

readFloat(): number

从MessageSequence实例中读取浮点值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeFloat(1.2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write float fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write float fail, errorMessage ' + e.message);
}
try {
  let ret = data.readFloat();
  hilog.info(0x0000, 'testTag', 'RpcClient: readFloat is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read float fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read float fail, errorMessage ' + e.message);
}

writeDouble

writeDouble(val: number): void

将双精度浮点值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeDouble(10.2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write double fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write double fail, errorMessage ' + e.message);
}

readDouble

readDouble(): number

从MessageSequence实例读取双精度浮点值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeDouble(10.2);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write double fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write double fail, errorMessage ' + e.message);
}
try {
  let ret = data.readDouble();
  hilog.info(0x0000, 'testTag', 'RpcClient: readDouble is ' +  ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read double fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read double fail, errorMessage ' + e.message);
}

writeBoolean

writeBoolean(val: boolean): void

将布尔值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeBoolean(false);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write boolean fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write boolean fail, errorMessage ' + e.message);
}

readBoolean

readBoolean(): boolean

从MessageSequence实例读取布尔值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeBoolean(false);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write boolean fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write boolean fail, errorMessage ' + e.message);
}
try {
  let ret = data.readBoolean();
  hilog.info(0x0000, 'testTag', 'RpcClient: readBoolean is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read boolean fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read boolean fail, errorMessage ' + e.message);
}

writeChar

writeChar(val: number): void

将单个字符值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeChar(97);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write char fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write char fail, errorMessage ' + e.message);
}

readChar

readChar(): number

从MessageSequence实例中读取单个字符值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeChar(97);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write char fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write char fail, errorMessage ' + e.message);
}
try {
  let ret = data.readChar();
  hilog.info(0x0000, 'testTag', 'RpcClient: readChar is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read char fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read char fail, errorMessage ' + e.message);
}

writeString

writeString(val: string): void

将字符串值写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeString('abc');
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write string fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write string fail, errorMessage ' + e.message);
}

readString

readString(): string

从MessageSequence实例读取字符串值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeString('abc');
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write string fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write string fail, errorMessage ' + e.message);
}
try {
  let ret = data.readString();
  hilog.info(0x0000, 'testTag', 'RpcClient: readString is ' + ret);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read string fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read string fail, errorMessage ' + e.message);
}

writeParcelable

writeParcelable(val: Parcelable): void

将自定义序列化对象写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';
  constructor( num: number, str: string) {
    this.num = num;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}
let parcelable = new MyParcelable(1, "aaa");
let data = rpc.MessageSequence.create();
try {
  data.writeParcelable(parcelable);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write parcelable fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write parcelable fail, errorMessage ' + e.message);
}

readParcelable

readParcelable(dataIn: Parcelable): void

从MessageSequence实例中读取成员变量到指定的对象（dataIn）。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';
  constructor(num: number, str: string) {
    this.num = num;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}
let parcelable = new MyParcelable(1, "aaa");
let data = rpc.MessageSequence.create();
data.writeParcelable(parcelable);
let ret = new MyParcelable(0, "");
try {
  data.readParcelable(ret);
}catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read parcelable fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read parcelable fail, errorMessage ' + e.message);
}

writeByteArray

writeByteArray(byteArray: number[]): void

将字节数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
try {
  data.writeByteArray(ByteArrayVar);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorMessage ' + e.message);
}

readByteArray

readByteArray(dataIn: number[]): void

从MessageSequence实例读取字节数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
try {
  data.writeByteArray(ByteArrayVar);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorMessage ' + e.message);
}
try {
  let array: Array<number> = new Array(5);
  data.readByteArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read byteArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read byteArray fail, errorMessage ' + e.message);
}

readByteArray

readByteArray(): number[]

从MessageSequence实例中读取字节数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
let byteArrayVar = [1, 2, 3, 4, 5];
try {
  data.writeByteArray(byteArrayVar);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write byteArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readByteArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readByteArray is ' +  array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read byteArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read byteArray fail, errorMessage ' + e.message);
}

writeShortArray

writeShortArray(shortArray: number[]): void

将短整数数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeShortArray([11, 12, 13]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorMessage ' + e.message);
}

readShortArray

readShortArray(dataIn: number[]): void

从MessageSequence实例中读取短整数数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeShortArray([11, 12, 13]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorMessage ' + e.message);
}
try {
  let array: Array<number> = new Array(3);
  data.readShortArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read shortArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read shortArray fail, errorMessage ' + e.message);
}

readShortArray

readShortArray(): number[]

从MessageSequence实例中读取短整数数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeShortArray([11, 12, 13]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write shortArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readShortArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readShortArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read shortArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read shortArray fail, errorMessage ' + e.message);
}

writeIntArray

writeIntArray(intArray: number[]): void

将整数数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeIntArray([100, 111, 112]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorMessage ' + e.message);
}

readIntArray

readIntArray(dataIn: number[]): void

从MessageSequence实例中读取整数数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeIntArray([100, 111, 112]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorMessage ' + e.message);
}
let array: Array<number> = new Array(3);
try {
  data.readIntArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read intArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read intArray fail, errorMessage ' + e.message);
}

readIntArray

readIntArray(): number[]

从MessageSequence实例中读取整数数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeIntArray([100, 111, 112]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write intArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readIntArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readIntArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read intArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read intArray fail, errorMessage ' + e.message);
}

writeLongArray

writeLongArray(longArray: number[]): void

将长整数数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeLongArray([1111, 1112, 1113]);
}catch (error){
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorMessage ' + e.message);
}

readLongArray

readLongArray(dataIn: number[]): void

从MessageSequence实例读取的长整数数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeLongArray([1111, 1112, 1113]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorMessage ' + e.message);
}
let array: Array<number> = new Array(3);
try {
  data.readLongArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read longArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read longArray fail, errorMessage ' + e.message);
}

readLongArray

readLongArray(): number[]

从MessageSequence实例中读取所有的长整数数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeLongArray([1111, 1112, 1113]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write longArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readLongArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readLongArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read longArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read longArray fail, errorMessage ' + e.message);
}

writeFloatArray

writeFloatArray(floatArray: number[]): void

将浮点数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeFloatArray([1.2, 1.3, 1.4]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorMessage ' + e.message);
}

readFloatArray

readFloatArray(dataIn: number[]): void

从MessageSequence实例中读取浮点数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeFloatArray([1.2, 1.3, 1.4]);
}catch (error){
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorMessage ' + e.message);
}
let array: Array<number> = new Array(3);
try {
  data.readFloatArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read floatArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read floatArray fail, errorMessage ' + e.message);
}

readFloatArray

readFloatArray(): number[]

从MessageSequence实例中读取浮点数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeFloatArray([1.2, 1.3, 1.4]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write floatArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readFloatArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readFloatArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read floatArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read floatArray fail, errorMessage ' + e.message);
}

writeDoubleArray

writeDoubleArray(doubleArray: number[]): void

将双精度浮点数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorMessage ' + e.message);
}

readDoubleArray

readDoubleArray(dataIn: number[]): void

从MessageSequence实例中读取双精度浮点数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorMessage ' + e.message);
}
let array: Array<number> = new Array(3);
try {
  data.readDoubleArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read doubleArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read doubleArray fail, errorMessage ' + e.message);
}

readDoubleArray

readDoubleArray(): number[]

从MessageSequence实例读取所有双精度浮点数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write doubleArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readDoubleArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readDoubleArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read doubleArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read doubleArray fail, errorMessage ' + e.message);
}

writeBooleanArray

writeBooleanArray(booleanArray: boolean[]): void

将布尔数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeBooleanArray([false, true, false]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorMessage ' + e.message);
}

readBooleanArray

readBooleanArray(dataIn: boolean[]): void

从MessageSequence实例中读取布尔数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeBooleanArray([false, true, false]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorMessage ' + e.message);
}
let array: Array<boolean> = new Array(3);
try {
  data.readBooleanArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read booleanArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read booleanArray fail, errorMessage ' + e.message);
}

readBooleanArray

readBooleanArray(): boolean[]

从MessageSequence实例中读取所有布尔数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeBooleanArray([false, true, false]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write booleanArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readBooleanArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readBooleanArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read booleanArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read booleanArray fail, errorMessage ' + e.message);
}

writeCharArray

writeCharArray(charArray: number[]): void

将单个字符数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeCharArray([97, 98, 88]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorMessage ' + e.message);
}

readCharArray

readCharArray(dataIn: number[]): void

从MessageSequence实例中读取单个字符数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeCharArray([97, 98, 88]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorMessage ' + e.message);
}
let array: Array<number> = new Array(3);
try {
  data.readCharArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read charArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read charArray fail, errorMessage ' + e.message);
}

readCharArray

readCharArray(): number[]

从MessageSequence实例读取单个字符数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeCharArray([97, 98, 88]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write charArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readCharArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readCharArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read charArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read charArray fail, errorMessage ' + e.message);
}

writeStringArray

writeStringArray(stringArray: string[]): void

将字符串数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeStringArray(["abc", "def"]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorMessage ' + e.message);
}

readStringArray

readStringArray(dataIn: string[]): void

从MessageSequence实例读取字符串数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeStringArray(["abc", "def"]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorMessage ' + e.message);
}
let array: Array<string> = new Array(2);
try {
  data.readStringArray(array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read stringArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read stringArray fail, errorMessage ' + e.message);
}

readStringArray

readStringArray(): string[]

从MessageSequence实例读取字符串数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let data = rpc.MessageSequence.create();
try {
  data.writeStringArray(["abc", "def"]);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write stringArray fail, errorMessage ' + e.message);
}
try {
  let array = data.readStringArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readStringArray is ' + array);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read stringArray fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read stringArray fail, errorMessage ' + e.message);
}

writeNoException

writeNoException(): void

向MessageSequence写入“指示未发生异常”的信息。

系统能力：SystemCapability.Communication.IPC.Core

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }
  onRemoteMessageRequest(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption): boolean | Promise<boolean> {
    if (code === 1) {
      hilog.info(0x0000, 'testTag', 'RpcServer: onRemoteMessageRequest called');
      try {
        reply.writeNoException();
      } catch (error) {
        let e: BusinessError = error as BusinessError;
        hilog.error(0x0000, 'testTag', 'rpc write no exception fail, errorCode ' + e.code);
        hilog.error(0x0000, 'testTag', 'rpc write no exception fail, errorMessage ' + e.message);
      }
      return true;
    } else {
      hilog.error(0x0000, 'testTag', 'RpcServer: unknown code: ' + code);
      return false;
    }
  }
}

readException

readException(): void

从MessageSequence中读取异常。

系统能力：SystemCapability.Communication.IPC.Core

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

Stage模型的应用在获取服务前需要先获取context，具体方法可参考获取context

// 仅FA模型需要导入@ohos.ability.featureAbility
// import FA from "@ohos.ability.featureAbility";
import Want from '@ohos.app.ability.Want';
import common from '@ohos.app.ability.common';
import hilog from '@ohos.hilog';

let proxy: rpc.IRemoteObject | undefined;
let connect: common.ConnectOptions = {
  onConnect: (elementName, remoteProxy) => {
    hilog.info(0x0000, 'testTag', 'RpcClient: js onConnect called');
    proxy = remoteProxy;
  },
  onDisconnect: (elementName) => {
    hilog.info(0x0000, 'testTag', 'RpcClient: onDisconnect');
  },
  onFailed: () => {
    hilog.info(0x0000, 'testTag', 'RpcClient: onFailed');
  }
};
let want: Want = {
  bundleName: "com.ohos.server",
  abilityName: "com.ohos.server.EntryAbility",
};

// FA模型使用此方法连接服务
// FA.connectAbility(want,connect);

this.context.connectServiceExtensionAbility(want, connect);

上述onConnect回调函数中的proxy对象需要等ability异步连接成功后才会被赋值，然后才可调用proxy对象的sendMessageRequest接口方法发送消息

import { BusinessError } from '@ohos.base';
import hilog from '@ohos.hilog';

let option = new rpc.MessageOption();
let data = rpc.MessageSequence.create();
let reply = rpc.MessageSequence.create();
data.writeNoException();
data.writeInt(6);
if (proxy != undefined) {
  proxy.sendMessageRequest(1, data, reply, option)
    .then((result: rpc.RequestResult) => {
      if (result.errCode === 0) {
        hilog.info(0x0000, 'testTag', 'sendMessageRequest got result');
        try {
          result.reply.readException();
        } catch (error) {
          let e: BusinessError = error as BusinessError;
          hilog.error(0x0000, 'testTag', 'rpc read exception fail, errorCode ' + e.code);
          hilog.error(0x0000, 'testTag', 'rpc read exception fail, errorMessage ' + e.message);
        }
        let num = result.reply.readInt();
        hilog.info(0x0000, 'testTag', 'RPCTest: reply num: ' + num);
      } else {
        hilog.error(0x0000, 'testTag', 'RPCTest: sendMessageRequest failed, errCode: ' + result.errCode);
      }
    }).catch((e: Error) => {
      hilog.error(0x0000, 'testTag', 'RPCTest: sendMessageRequest got exception: ' + e.message);
    }).finally (() => {
      hilog.info(0x0000, 'testTag', 'RPCTest: sendMessageRequest ends, reclaim parcel');
      data.reclaim();
      reply.reclaim();
    });
}

writeParcelableArray

writeParcelableArray(parcelableArray: Parcelable[]): void

将可序列化对象数组写入MessageSequence实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';
  constructor(num: number, str: string) {
    this.num = num;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}
let parcelable = new MyParcelable(1, "aaa");
let parcelable2 = new MyParcelable(2, "bbb");
let parcelable3 = new MyParcelable(3, "ccc");
let a = [parcelable, parcelable2, parcelable3];
let data = rpc.MessageSequence.create();
try {
  data.writeParcelableArray(a);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write parcelable array fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write parcelable array fail, errorMessage ' + e.message);
}

readParcelableArray

readParcelableArray(parcelableArray: Parcelable[]): void

从MessageSequence实例读取可序列化对象数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class MyParcelable implements rpc.Parcelable {
  num: number = 0;
  str: string = '';
  constructor(num: number, str: string) {
    this.num = num;
    this.str = str;
  }
  marshalling(messageSequence: rpc.MessageSequence): boolean {
    messageSequence.writeInt(this.num);
    messageSequence.writeString(this.str);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence): boolean {
    this.num = messageSequence.readInt();
    this.str = messageSequence.readString();
    return true;
  }
}
let parcelable = new MyParcelable(1, "aaa");
let parcelable2 = new MyParcelable(2, "bbb");
let parcelable3 = new MyParcelable(3, "ccc");
let a = [parcelable, parcelable2, parcelable3];
let data = rpc.MessageSequence.create();
data.writeParcelableArray(a);
let b = [new MyParcelable(0, ""), new MyParcelable(0, ""), new MyParcelable(0, "")];
try {
  data.readParcelableArray(b);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read parcelable array fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read parcelable array fail, errorMessage ' + e.message);
}

writeRemoteObjectArray

writeRemoteObjectArray(objectArray: IRemoteObject[]): void

将IRemoteObject对象数组写入MessageSequence。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
    this.modifyLocalInterface(this, descriptor);
  }

  asObject(): rpc.IRemoteObject {
    return this;
  }
}
let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")];
let data = rpc.MessageSequence.create();
try {
  data.writeRemoteObjectArray(a);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write remote object array fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write remote object array fail, errorMessage ' + e.message);
}

readRemoteObjectArray

readRemoteObjectArray(objects: IRemoteObject[]): void

从MessageSequence读取IRemoteObject对象数组。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
    this.modifyLocalInterface(this, descriptor);
  }

  asObject(): rpc.IRemoteObject {
    return this;
  }
}
let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")];
let data = rpc.MessageSequence.create();
data.writeRemoteObjectArray(a);
let b: Array<rpc.IRemoteObject> = new Array(3);
try {
  data.readRemoteObjectArray(b);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read remote object array fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read remote object array fail, errorMessage ' + e.message);
}

readRemoteObjectArray

readRemoteObjectArray(): IRemoteObject[]

从MessageSequence读取IRemoteObject对象数组。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
    this.modifyLocalInterface(this, descriptor);
  }

  asObject(): rpc.IRemoteObject {
    return this;
  }
}
let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")];
let data = rpc.MessageSequence.create();
data.writeRemoteObjectArray(a);
try {
  let b = data.readRemoteObjectArray();
  hilog.info(0x0000, 'testTag', 'RpcClient: readRemoteObjectArray is ' + b);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read remote object array fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read remote object array fail, errorMessage ' + e.message);
}

closeFileDescriptor

static closeFileDescriptor(fd: number): void

静态方法，关闭给定的文件描述符。

系统能力：SystemCapability.Communication.IPC.Core

参数：

示例：

import fs from '@ohos.file.fs';
import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
  rpc.MessageSequence.closeFileDescriptor(file.fd);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc close file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc close file descriptor fail, errorMessage ' + e.message);
}

dupFileDescriptor

static dupFileDescriptor(fd: number) :number

静态方法，复制给定的文件描述符。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import fs from '@ohos.file.fs';
import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
  rpc.MessageSequence.dupFileDescriptor(file.fd);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc dup file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc dup file descriptor fail, errorMessage ' + e.message);
}

containFileDescriptors

containFileDescriptors(): boolean

检查此MessageSequence对象是否包含文件描述符。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import fs from '@ohos.file.fs';
import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
  sequence.writeFileDescriptor(file.fd);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorMessage ' + e.message);
}
try {
  let containFD = sequence.containFileDescriptors();
  hilog.info(0x0000, 'testTag', 'RpcTest: sequence after write fd containFd result is ' + containFD);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc contain file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc contain file descriptor fail, errorMessage ' + e.message);
}

writeFileDescriptor

writeFileDescriptor(fd: number): void

写入文件描述符到MessageSequence。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import fs from '@ohos.file.fs';
import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
  sequence.writeFileDescriptor(file.fd);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorMessage ' + e.message);
}

readFileDescriptor

readFileDescriptor(): number

从MessageSequence中读取文件描述符。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import fs from '@ohos.file.fs';
import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
  sequence.writeFileDescriptor(file.fd);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write file descriptor fail, errorMessage ' + e.message);
}
try {
  let readFD = sequence.readFileDescriptor();
  hilog.info(0x0000, 'testTag', 'RpcClient: readFileDescriptor is ' + readFD);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read file descriptor fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read file descriptor fail, errorMessage ' + e.message);
}

writeAshmem

writeAshmem(ashmem: Ashmem): void

将指定的匿名共享对象写入此MessageSequence。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let ashmem: rpc.Ashmem | undefined = undefined;
try {
  ashmem = rpc.Ashmem.create("ashmem", 1024);
  try {
    sequence.writeAshmem(ashmem);
  } catch (error) {
    let e: BusinessError = error as BusinessError;
    hilog.error(0x0000, 'testTag', 'rpc write ashmem fail, errorCode ' + e.code);
    hilog.error(0x0000, 'testTag', 'rpc write ashmem fail, errorMessage ' + e.message);
  }
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc create ashmem fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc create ashmem fail, errorMessage ' + e.message);
}

readAshmem

readAshmem(): Ashmem

从MessageSequence读取匿名共享对象。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let ashmem: rpc.Ashmem | undefined = undefined;
try {
  ashmem = rpc.Ashmem.create("ashmem", 1024);
  try {
    sequence.writeAshmem(ashmem);
  } catch (error) {
    let e: BusinessError = error as BusinessError;
    hilog.error(0x0000, 'testTag', 'rpc write ashmem fail, errorCode ' + e.code);
    hilog.error(0x0000, 'testTag', 'rpc write ashmem fail, errorMessage ' + e.message);
  }
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc create ashmem fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc create ashmem fail, errorMessage ' + e.message);
}
try {
  sequence.readAshmem();
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read ashmem fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read ashmem fail, errorMessage ' + e.message);
}

getRawDataCapacity

getRawDataCapacity(): number

获取MessageSequence可以容纳的最大原始数据量。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let sequence = new rpc.MessageSequence();
let result = sequence.getRawDataCapacity();
hilog.info(0x0000, 'testTag', 'RpcTest: sequence get RawDataCapacity result is ' + result);

writeRawData

writeRawData(rawData: number[], size: number): void

将原始数据写入MessageSequence对象。

系统能力：SystemCapability.Communication.IPC.Core

参数：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let arr = [1, 2, 3, 4, 5];
try {
  sequence.writeRawData(arr, arr.length);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write rawdata fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write rawdata fail, errorMessage ' + e.message);
}

readRawData

readRawData(size: number): number[]

从MessageSequence读取原始数据。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.rpc错误码

示例：

import hilog from '@ohos.hilog';
import { BusinessError } from '@ohos.base';

let sequence = new rpc.MessageSequence();
let arr = [1, 2, 3, 4, 5];
try {
  sequence.writeRawData(arr, arr.length);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc write rawdata fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc write rawdata fail, errorMessage ' + e.message);
}
try {
  let result = sequence.readRawData(5);
  hilog.info(0x0000, 'testTag', 'RpcTest: sequence read raw data result is ' + result);
} catch (error) {
  let e: BusinessError = error as BusinessError;
  hilog.error(0x0000, 'testTag', 'rpc read rawdata fail, errorCode ' + e.code);
  hilog.error(0x0000, 'testTag', 'rpc read rawdata fail, errorMessage ' + e.message);
}

MessageParcel^(deprecated)

从API version 9 开始不再维护，建议使用MessageSequence类替代。

在RPC过程中，发送方可以使用MessageParcel提供的写方法，将待发送的数据以特定格式写入该对象。接收方可以使用MessageParcel提供的读方法从该对象中读取特定格式的数据。数据格式包括：基础类型及数组、IPC对象、接口描述符和自定义序列化对象。

create

static create(): MessageParcel

静态方法，创建MessageParcel对象。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
hilog.info(0x0000, 'testTag', 'RpcClient: data is ' + data);

reclaim

reclaim(): void

释放不再使用的MessageParcel对象。

系统能力：SystemCapability.Communication.IPC.Core

示例：

let reply = rpc.MessageParcel.create();
reply.reclaim();

writeRemoteObject

writeRemoteObject(object: IRemoteObject): boolean

序列化远程对象并将其写入MessageParcel对象。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

class MyDeathRecipient implements rpc.DeathRecipient {
  onRemoteDied() {
    hilog.info(0x0000, 'testTag', 'server died');
  }
}
class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }
  addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }
  removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }
  isObjectDead(): boolean {
    return false;
  }
}
let data = rpc.MessageParcel.create();
let testRemoteObject = new TestRemoteObject("testObject");
data.writeRemoteObject(testRemoteObject);

readRemoteObject

readRemoteObject(): IRemoteObject

从MessageParcel读取远程对象。此方法用于反序列化MessageParcel对象以生成IRemoteObject。远程对象按写入MessageParcel的顺序读取。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class MyDeathRecipient implements rpc.DeathRecipient {
  onRemoteDied() {
    hilog.info(0x0000, 'testTag', 'server died');
  }
}
class TestRemoteObject extends rpc.RemoteObject {
  constructor(descriptor: string) {
    super(descriptor);
  }
  addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }
  removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
    return true;
  }
  isObjectDead(): boolean {
    return false;
  }
}
let data = rpc.MessageParcel.create();
let testRemoteObject = new TestRemoteObject("testObject");
data.writeRemoteObject(testRemoteObject);
let proxy = data.readRemoteObject();
hilog.info(0x0000, 'testTag', 'readRemoteObject is ' + proxy);

writeInterfaceToken

writeInterfaceToken(token: string): boolean

将接口描述符写入MessageParcel对象，远端对象可使用该信息校验本次通信。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeInterfaceToken("aaa");
hilog.info(0x0000, 'testTag', 'RpcServer: writeInterfaceToken is ' + result);

readInterfaceToken

readInterfaceToken(): string

从MessageParcel中读取接口描述符，接口描述符按写入MessageParcel的顺序读取，本地对象可使用该信息检验本次通信。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class Stub extends rpc.RemoteObject {
  onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption): boolean {
    let interfaceToken = data.readInterfaceToken();
    hilog.info(0x0000, 'testTag', 'RpcServer: interfaceToken is ' + interfaceToken);
    return true;
  }
}

getSize

getSize(): number

获取当前MessageParcel的数据大小。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let size = data.getSize();
hilog.info(0x0000, 'testTag', 'RpcClient: size is ' + size);

getCapacity

getCapacity(): number

获取当前MessageParcel的容量。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.getCapacity();
hilog.info(0x0000, 'testTag', 'RpcClient: capacity is ' + result);

setSize

setSize(size: number): boolean

设置MessageParcel实例中包含的数据大小。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let setSize = data.setSize(16);
hilog.info(0x0000, 'testTag', 'RpcClient: setSize is ' + setSize);

setCapacity

setCapacity(size: number): boolean

设置MessageParcel实例的存储容量。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.setCapacity(100);
hilog.info(0x0000, 'testTag', 'RpcClient: setCapacity is ' + result);

getWritableBytes

getWritableBytes(): number

获取MessageParcel的可写字节空间。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class Stub extends rpc.RemoteObject {
  onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption): boolean {
    let getWritableBytes = data.getWritableBytes();
    hilog.info(0x0000, 'testTag', 'RpcServer: getWritableBytes is ' + getWritableBytes);
    return true;
  }
}

getReadableBytes

getReadableBytes(): number

获取MessageParcel的可读字节空间。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

class Stub extends rpc.RemoteObject {
  onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption): boolean {
    let result = data.getReadableBytes();
    hilog.info(0x0000, 'testTag', 'RpcServer: getReadableBytes is ' + result);
    return true;
  }
}

getReadPosition

getReadPosition(): number

获取MessageParcel的读位置。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let readPos = data.getReadPosition();
hilog.info(0x0000, 'testTag', 'RpcClient: readPos is ' + readPos);

getWritePosition

getWritePosition(): number

获取MessageParcel的写位置。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
data.writeInt(10);
let bwPos = data.getWritePosition();
hilog.info(0x0000, 'testTag', 'RpcClient: bwPos is ' + bwPos);

rewindRead

rewindRead(pos: number): boolean

重新偏移读取位置到指定的位置。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
data.writeInt(12);
data.writeString("parcel");
let number = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: number is ' + number);
data.rewindRead(0);
let number2 = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: rewindRead is ' + number2);

rewindWrite

rewindWrite(pos: number): boolean

重新偏移写位置到指定的位置。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
data.writeInt(4);
data.rewindWrite(0);
data.writeInt(5);
let number = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: rewindWrite is ' + number);

writeByte

writeByte(val: number): boolean

将字节值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeByte(2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeByte is ' + result);

readByte

readByte(): number

从MessageParcel实例读取字节值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeByte(2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeByte is ' + result);
let ret = data.readByte();
hilog.info(0x0000, 'testTag', 'RpcClient: readByte is ' + ret);

writeShort

writeShort(val: number): boolean

将短整数值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeShort(8);
hilog.info(0x0000, 'testTag', 'RpcClient: writeShort is ' + result);

readShort

readShort(): number

从MessageParcel实例读取短整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeShort(8);
hilog.info(0x0000, 'testTag', 'RpcClient: writeShort is ' + result);
let ret = data.readShort();
hilog.info(0x0000, 'testTag', 'RpcClient: readShort is ' + ret);

writeInt

writeInt(val: number): boolean

将整数值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeInt(10);
hilog.info(0x0000, 'testTag', 'RpcClient: writeInt is ' + result);

readInt

readInt(): number

从MessageParcel实例读取整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeInt(10);
hilog.info(0x0000, 'testTag', 'RpcClient: writeInt is ' + result);
let ret = data.readInt();
hilog.info(0x0000, 'testTag', 'RpcClient: readInt is ' + ret);

writeLong

writeLong(val: number): boolean

将长整数值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeLong(10000);
hilog.info(0x0000, 'testTag', 'RpcClient: writeLong is ' + result);

readLong

readLong(): number

从MessageParcel实例中读取长整数值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeLong(10000);
hilog.info(0x0000, 'testTag', 'RpcClient: writeLong is ' + result);
let ret = data.readLong();
hilog.info(0x0000, 'testTag', 'RpcClient: readLong is ' + ret);

writeFloat

writeFloat(val: number): boolean

将浮点值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeFloat(1.2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeFloat is ' + result);

readFloat

readFloat(): number

从MessageParcel实例中读取浮点值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeFloat(1.2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeFloat is ' + result);
let ret = data.readFloat();
hilog.info(0x0000, 'testTag', 'RpcClient: readFloat is ' + ret);

writeDouble

writeDouble(val: number): boolean

将双精度浮点值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeDouble(10.2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeDouble is ' + result);

readDouble

readDouble(): number

从MessageParcel实例读取双精度浮点值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeDouble(10.2);
hilog.info(0x0000, 'testTag', 'RpcClient: writeDouble is ' + result);
let ret = data.readDouble();
hilog.info(0x0000, 'testTag', 'RpcClient: readDouble is ' + ret);

writeBoolean

writeBoolean(val: boolean): boolean

将布尔值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeBoolean(false);
hilog.info(0x0000, 'testTag', 'RpcClient: writeBoolean is ' + result);

readBoolean

readBoolean(): boolean

从MessageParcel实例读取布尔值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeBoolean(false);
hilog.info(0x0000, 'testTag', 'RpcClient: writeBoolean is ' + result);
let ret = data.readBoolean();
hilog.info(0x0000, 'testTag', 'RpcClient: readBoolean is ' + ret);

writeChar

writeChar(val: number): boolean

将单个字符值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeChar(97);
hilog.info(0x0000, 'testTag', 'RpcClient: writeChar is ' + result);

readChar

readChar(): number

从MessageParcel实例中读取单个字符值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeChar(97);
hilog.info(0x0000, 'testTag', 'RpcClient: writeChar is ' + result);
let ret = data.readChar();
hilog.info(0x0000, 'testTag', 'RpcClient: readChar is ' + ret);

writeString

writeString(val: string): boolean

将字符串值写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeString('abc');
hilog.info(0x0000, 'testTag', 'RpcClient: writeString is ' + result);

readString

readString(): string

从MessageParcel实例读取字符串值。

系统能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

import hilog from '@ohos.hilog';

let data = rpc.MessageParcel.create();
let result = data.writeString('abc');
hilog.info(0x0000, 'testTag', 'RpcClient: writeString is ' + result);
let ret = data.readString();
hilog.info(0x0000, 'testTag', 'RpcClient: readString is ' + ret);

writeSequenceable

writeSequenceable(val: Sequenceable): boolean

将自定义序列化对象写入MessageParcel实例。

系统能力：SystemCapability.Communication.IPC.Core

参数：

返回值：

示例：

import hilog from '@ohos.hilog';

class MySequenceable implements rpc.Sequenceable {
  num: number = 0;
  str: string = '';
  constructor(num: number, str: string) {
    this.num = num;
    this.str = str;
  }
  marshalling(messageParcel: rpc.MessageParcel): boolean {
    messageParcel.writeInt(this.num);
    messageParcel.writeString(this.str);
    return true;
  }
  unmarshalling(messageParcel: rpc.MessageParcel): boolean {
    this.num = messageParcel.readInt();
    this.str = messageParcel.readString();
    return true;
  }
}
let sequenceable = new MySequenceable(1, "aaa");
let data = rpc.MessageParcel.create();
let result = data.writeSequenceable(sequenceable);
hilog.info(0x0000, 'testTag', 'RpcClient: writeSequenceable is ' + result);

readSequenceable

readSequenceable(dataIn: Sequenceable): boolean

从MessageParcel实例中读取成员变量到指定的对象（dataIn）。

系统能力：SystemCapability.Communication.IPC.Core

参数：