@ohos.rpc (RPC)

The RPC module implements communication between processes, including inter-process communication (IPC) on a single device and remote procedure call (RPC) between processes on difference devices. IPC is implemented based on the Binder driver, and RPC is based on the DSoftBus driver.

NOTE

• The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

• This module supports return of error codes since API version 9.

Modules to Import

import rpc from '@ohos.rpc';

ErrorCode⁹⁺

The APIs of this module return exceptions since API version 9. The following table lists the error codes.

System capability: SystemCapability.Communication.IPC.Core

MessageSequence⁹⁺

Provides APIs for reading and writing data in specific format. During RPC or IPC, the sender can use the write() method provided by MessageSequence to write data in specific format to a MessageSequence object. The receiver can use the read() method provided by MessageSequence to read data in specific format from a MessageSequence object. The data formats include basic data types and arrays, IPC objects, interface tokens, and custom sequenceable objects.

create

static create(): MessageSequence

Creates a MessageSequence object. This API is a static method.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

import hilog from '@ohos.hilog';

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

reclaim

reclaim(): void

Reclaims the MessageSequence object that is no longer used.

System capability: SystemCapability.Communication.IPC.Core

Example

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

writeRemoteObject

writeRemoteObject(object: IRemoteObject): void

Serializes a remote object and writes it to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the remote object from MessageSequence. You can use this API to deserialize the MessageSequence object to generate an IRemoteObject. The remote object is read in the order in which it is written to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes an interface token to this MessageSequence object. The remote object can use this interface token to verify the communication.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the interface token from this MessageSequence object. The interface token is read in the sequence in which it is written to the MessageSequence object. The local object can use it to verify the communication.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Obtains the data size of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the capacity of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Sets the size of the data contained in this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

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

Sets the storage capacity of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Obtains the writable capacity (in bytes) of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the readable capacity of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the read position of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the write position of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Moves the read pointer to the specified position.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

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

Moves the write pointer to the specified position.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

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

Writes a byte value to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the byte value from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a short integer to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the short integer from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes an integer to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the integer from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a long integer to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the long integer from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a floating-point number to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the floating-pointer number from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a double-precision floating-point number to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the double-precision floating-point number from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a Boolean value to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the Boolean value from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a character to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the character from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a string to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the string from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a Parcelable object to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a Parcelable object from this MessageSequence object to the specified object (dataIn).

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a byte array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a byte array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the byte array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a short array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a short array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the short array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes an integer array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads an integer array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the integer array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a long array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a long array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the long integer array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a floating-point array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a floating-point array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the floating-point array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a double-precision floating-point array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a double-precision floating-point array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the double-precision floating-point array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a Boolean array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a Boolean array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the Boolean array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a character array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a character array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the character array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes a string array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a string array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the string array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes information to this MessageSequence object indicating that no exception occurred.

System capability: SystemCapability.Communication.IPC.Core

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the exception information from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Error codes

For details about the error codes, see RPC Error Codes.

Example

Before obtaining the ability for the application developed based on the stage model, obtain the context. For details, see Obtaining the Context.

// Import @ohos.ability.featureAbility only for the application developed based on the FA model.
// 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",
};

// Use this method to connect to the ability for the FA model.
// FA.connectAbility(want,connect);

this.context.connectServiceExtensionAbility(want, connect);

The proxy object in the onConnect callback can be assigned a value only after the ability is connected asynchronously. Then, sendMessageRequest() of the proxy object is called to send a message.

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

Writes a Parcelable array to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads a Parcelable array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes an array of IRemoteObject objects to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads an array of IRemoteObject objects from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads the IRemoteObject object array from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Closes a file descriptor. This API is a static method.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

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

Duplicates a file descriptor. This API is a static method.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Checks whether this MessageSequence object contains file descriptors.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a file descriptor to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the file descriptor from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Writes an anonymous shared object to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Reads the anonymous shared object from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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

Obtains the maximum amount of raw data that can be held by this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes raw data to this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Error codes

For details about the error codes, see RPC Error Codes.

Example

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[]

Reads raw data from this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Error codes

For details about the error codes, see RPC Error Codes.

Example

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)

This class is no longer maintained since API version 9. You are advised to use MessageSequence.

Provides APIs for reading and writing data in specific format. During RPC, the sender can use the write() method provided by MessageParcel to write data in specific format to a MessageParcel object. The receiver can use the read() method provided by MessageParcel to read data in specific format from a MessageParcel object. The data formats include basic data types and arrays, IPC objects, interface tokens, and custom sequenceable objects.

create

static create(): MessageParcel

Creates a MessageParcel object. This method is a static method.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

import hilog from '@ohos.hilog';

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

reclaim

reclaim(): void

Reclaims the MessageParcel object that is no longer used.

System capability: SystemCapability.Communication.IPC.Core

Example

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

writeRemoteObject

writeRemoteObject(object: IRemoteObject): boolean

Serializes a remote object and writes it to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the remote object from this MessageParcel object. You can use this method to deserialize the MessageParcel object to generate an IRemoteObject. The remote objects are read in the order in which they are written to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes an interface token to this MessageParcel object. The remote object can use this interface token to verify the communication.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the interface token from this MessageParcel object. The interface token is read in the sequence in which it is written to the MessageParcel object. The local object can use it to verify the communication.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the data size of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Sets the size of data contained in this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Sets the storage capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Obtains the writable capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the readable capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the read position of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Obtains the write position of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Moves the read pointer to the specified position.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Moves the write pointer to the specified position.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Writes a Byte value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Byte value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Short int value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Short int value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes an Int value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Int value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Long int value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Long int value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Float value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Float value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Double value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Double value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Boolean value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Boolean value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a Char value to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

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

Reads the Char value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

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

Writes a string to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters