@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

let data = rpc.MessageSequence.create();
console.log("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

class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        super(descriptor);
    }
}
let data = rpc.MessageSequence.create();
let testRemoteObject = new TestRemoteObject("testObject");
try {
    data.writeRemoteObject(testRemoteObject);
} catch(error) {
    console.info("Rpc write remote object fail, errorCode " + error.code);
    console.info("Rpc write remote object fail, errorMessage " + error.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

class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        super(descriptor);
    }
}
let data = rpc.MessageSequence.create();
let testRemoteObject = new TestRemoteObject("testObject");
try {
    data.writeRemoteObject(testRemoteObject);
    let proxy = data.readRemoteObject();
} catch(error) {
    console.info("Rpc write remote object fail, errorCode " + error.code);
    console.info("Rpc write remote object fail, errorMessage " + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeInterfaceToken("aaa");
} catch(error) {
    console.info("rpc write interface fail, errorCode " + error.code);
    console.info("rpc write interface fail, errorMessage " + error.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

class Stub extends rpc.RemoteObject {
    onRemoteRequest(code, data, reply, option) {
        try {
            let interfaceToken = data.readInterfaceToken();
            console.log("RpcServer: interfaceToken is " + interfaceToken);
        } catch(error) {
            console.info("RpcServer: read interfaceToken failed, errorCode " + error.code);
            console.info("RpcServer: read interfaceToken failed, errorMessage " + error.message);
        }
        return true;
    }
}

getSize

getSize(): number

Obtains the data size of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageSequence.create();
let size = data.getSize();
console.log("RpcClient: size is " + size);

getCapacity

getCapacity(): number

Obtains the capacity of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageSequence.create();
let result = data.getCapacity();
console.log("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

let data = rpc.MessageSequence.create();
try {
    data.setSize(16);
    console.log("RpcClient: setSize is " + data.getSize());
} catch(error) {
    console.info("rpc set size of MessageSequence fail, errorCode " + error.code);
    console.info("rpc set size of MessageSequence fail, errorMessage " + error.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

let data = rpc.MessageSequence.create();
try {
    data.setCapacity(100);
    console.log("RpcClient: setCapacity is " + data.getCapacity());
} catch(error) {
    console.info("rpc memory alloc fail, errorCode " + error.code);
    console.info("rpc memory alloc fail, errorMessage " + error.message);
}

getWritableBytes

getWritableBytes(): number

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

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

class Stub extends rpc.RemoteObject {
    onRemoteRequest(code, data, reply, option) {
        let getWritableBytes = data.getWritableBytes();
        console.log("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

class Stub extends rpc.RemoteObject {
  onRemoteRequest(code, data, reply, option) {
      let result = data.getReadableBytes();
      console.log("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

let data = rpc.MessageSequence.create();
let readPos = data.getReadPosition();
console.log("RpcClient: readPos is " + readPos);

getWritePosition

getWritePosition(): number

Obtains the write position of this MessageSequence object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageSequence.create();
data.writeInt(10);
let bwPos = data.getWritePosition();
console.log("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

let data = rpc.MessageSequence.create();
data.writeInt(12);
data.writeString("sequence");
let number = data.readInt();
console.log("RpcClient: number is " + number);
try {
    data.rewindRead(0);
} catch(error) {
    console.info("rpc rewind read data fail, errorCode " + error.code);
    console.info("rpc rewind read data fail, errorMessage " + error.message);
}
let number2 = data.readInt();
console.log("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

let data = rpc.MessageSequence.create();
data.writeInt(4);
try {
    data.rewindWrite(0);
} catch(error) {
    console.info("rpc rewind read data fail, errorCode " + error.code);
    console.info("rpc rewind read data fail, errorMessage " + error.message);
}
data.writeInt(5);
let number = data.readInt();
console.log("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

let data = rpc.MessageSequence.create();
try {
    data.writeByte(2);
} catch(error) {
  console.info("rpc write byte fail, errorCode " + error.code);
  console.info("rpc write byte fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeByte(2);
} catch(error) {
  console.info("rpc write byte fail, errorCode " + error.code);
  console.info("rpc write byte fail, errorMessage" + error.message);
}
try {
    let ret = data.readByte();
    console.log("RpcClient: readByte is: " + ret);
} catch(error) {
  console.info("rpc write byte fail, errorCode " + error.code);
  console.info("rpc write byte fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeShort(8);
} catch(error) {
    console.info("rpc write short fail, errorCode " + error.code);
    console.info("rpc write short fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeShort(8);
} catch(error) {
    console.info("rpc write short fail, errorCode " + error.code);
    console.info("rpc write short fail, errorMessage" + error.message);
}
try {
    let ret = data.readShort();
    console.log("RpcClient: readByte is: " + ret);
} catch(error) {
    console.info("rpc read short fail, errorCode " + error.code);
    console.info("rpc read short fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeInt(10);
} catch(error) {
    console.info("rpc write int fail, errorCode " + error.code);
    console.info("rpc write int fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeInt(10);
} catch(error) {
    console.info("rpc write int fail, errorCode " + error.code);
    console.info("rpc write int fail, errorMessage" + error.message);
}
try {
    let ret = data.readInt();
    console.log("RpcClient: readInt is " + ret);
} catch(error) {
    console.info("rpc read int fail, errorCode " + error.code);
    console.info("rpc read int fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeLong(10000);
} catch(error) {
    console.info("rpc write long fail, errorCode " + error.code);
    console.info("rpc write long fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeLong(10000);
} catch(error) {
    console.info("rpc write long fail, errorCode " + error.code);
    console.info("rpc write long fail, errorMessage" + error.message);
}
try {
    let ret = data.readLong();
    console.log("RpcClient: readLong is " + ret);
} catch(error) {
    console.info("rpc read long fail, errorCode " + error.code);
    console.info("rpc read long fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeFloat(1.2);
} catch(error) {
    console.info("rpc write float fail, errorCode " + error.code);
    console.info("rpc write float fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeFloat(1.2);
} catch(error) {
    console.info("rpc write float fail, errorCode " + error.code);
    console.info("rpc write float fail, errorMessage" + error.message);
}
try {
    let ret = data.readFloat();
    console.log("RpcClient: readFloat is " + ret);
} catch(error) {
    console.info("rpc read float fail, errorCode " + error.code);
    console.info("rpc read float fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeDouble(10.2);
} catch(error) {
    console.info("rpc read float fail, errorCode " + error.code);
    console.info("rpc read float fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeDouble(10.2);
} catch(error) {
    console.info("rpc write double fail, errorCode " + error.code);
    console.info("rpc write double fail, errorMessage" + error.message);
}
try {
    let ret = data.readDouble();
    console.log("RpcClient: readDouble is " + ret);
} catch(error) {
    console.info("rpc read double fail, errorCode " + error.code);
    console.info("rpc read double fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeBoolean(false);
} catch(error) {
    console.info("rpc write boolean fail, errorCode " + error.code);
    console.info("rpc write boolean fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeBoolean(false);
} catch(error) {
    console.info("rpc write boolean fail, errorCode " + error.code);
    console.info("rpc write boolean fail, errorMessage" + error.message);
}
try {
    let ret = data.readBoolean();
    console.log("RpcClient: readBoolean is " + ret);
} catch(error) {
    console.info("rpc read boolean fail, errorCode " + error.code);
    console.info("rpc read boolean fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeChar(97);
} catch(error) {
    console.info("rpc write char fail, errorCode " + error.code);
    console.info("rpc write char fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeChar(97);
} catch(error) {
    console.info("rpc write char fail, errorCode " + error.code);
    console.info("rpc write char fail, errorMessage" + error.message);
}
try {
    let ret = data.readChar();
    console.log("RpcClient: readChar is " + ret);
} catch(error) {
    console.info("rpc read char fail, errorCode " + error.code);
    console.info("rpc read char fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeString('abc');
} catch(error) {
    console.info("rpc write string fail, errorCode " + error.code);
    console.info("rpc write string fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeString('abc');
} catch(error) {
    console.info("rpc write string fail, errorCode " + error.code);
    console.info("rpc write string fail, errorMessage" + error.message);
}
try {
    let ret = data.readString();
    console.log("RpcClient: readString is " + ret);
} catch(error) {
    console.info("rpc read string fail, errorCode " + error.code);
    console.info("rpc read string fail, errorMessage" + error.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

class MySequenceable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num);
        messageSequence.writeString(this.str);
        return true;
    }
    unmarshalling(messageSequence) {
        this.num = messageSequence.readInt();
        this.str = messageSequence.readString();
        return true;
    }
}
let parcelable = new MySequenceable(1, "aaa");
let data = rpc.MessageSequence.create();
try {
    data.writeParcelable(parcelable);
} catch(error) {
    console.info("rpc write parcelable fail, errorCode " + error.code);
    console.info("rpc write parcelable fail, errorMessage" + error.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

class MySequenceable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num);
        messageSequence.writeString(this.str);
        return true;
    }
    unmarshalling(messageSequence) {
        this.num = messageSequence.readInt();
        this.str = messageSequence.readString();
        return true;
    }
}
let parcelable = new MySequenceable(1, "aaa");
let data = rpc.MessageSequence.create();
data.writeParcelable(parcelable);
let ret = new MySequenceable(0, "");
try {
    data.readParcelable(ret);
}catch(error) {
    console.info("rpc read parcelable fail, errorCode " + error.code);
    console.info("rpc read parcelable fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
try {
    data.writeByteArray(ByteArrayVar);
} catch(error) {
    console.info("rpc write byteArray fail, errorCode " + error.code);
    console.info("rpc write byteArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
try {
    data.writeByteArray(ByteArrayVar);
} catch(error) {
    console.info("rpc write byteArray fail, errorCode " + error.code);
    console.info("rpc write byteArray fail, errorMessage" + error.message);
}
try {
    let array = new Array(5);
    data.readByteArray(array);
} catch(error) {
    console.info("rpc write byteArray fail, errorCode " + error.code);
    console.info("rpc write byteArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
let byteArrayVar = [1, 2, 3, 4, 5];
try {
    data.writeByteArray(byteArrayVar);
} catch(error) {
    console.info("rpc write byteArray fail, errorCode " + error.code);
    console.info("rpc write byteArray fail, errorMessage" + error.message);
}
try {
    let array = data.readByteArray();
    console.log("RpcClient: readByteArray is " + array);
} catch(error) {
    console.info("rpc read byteArray fail, errorCode " + error.code);
    console.info("rpc read byteArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeShortArray([11, 12, 13]);
} catch(error) {
    console.info("rpc read byteArray fail, errorCode " + error.code);
    console.info("rpc read byteArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeShortArray([11, 12, 13]);
} catch(error) {
    console.info("rpc write shortArray fail, errorCode " + error.code);
    console.info("rpc write shortArray fail, errorMessage" + error.message);
}
try {
    let array = new Array(3);
    data.readShortArray(array);
} catch(error) {
    console.info("rpc read shortArray fail, errorCode " + error.code);
    console.info("rpc read shortArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeShortArray([11, 12, 13]);
} catch(error) {
    console.info("rpc write shortArray fail, errorCode " + error.code);
    console.info("rpc write shortArray fail, errorMessage" + error.message);
}
try {
    let array = data.readShortArray();
    console.log("RpcClient: readShortArray is " + array);
} catch(error) {
    console.info("rpc read shortArray fail, errorCode " + error.code);
    console.info("rpc read shortArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeIntArray([100, 111, 112]);
} catch(error) {
    console.info("rpc write intArray fail, errorCode " + error.code);
    console.info("rpc write intArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeIntArray([100, 111, 112]);
} catch(error) {
    console.info("rpc write intArray fail, errorCode " + error.code);
    console.info("rpc write intArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readIntArray(array);
} catch(error) {
    console.info("rpc read intArray fail, errorCode " + error.code);
    console.info("rpc read intArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeIntArray([100, 111, 112]);
} catch(error) {
    console.info("rpc write intArray fail, errorCode " + error.code);
    console.info("rpc write intArray fail, errorMessage" + error.message);
}
try {
  let array = data.readIntArray();
  console.log("RpcClient: readIntArray is " + array);
} catch(error) {
    console.info("rpc read intArray fail, errorCode " + error.code);
    console.info("rpc read intArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeLongArray([1111, 1112, 1113]);
}catch(error){
    console.info("rpc write longArray fail, errorCode " + error.code);
    console.info("rpc write longArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeLongArray([1111, 1112, 1113]);
} catch(error) {
    console.info("rpc write longArray fail, errorCode " + error.code);
    console.info("rpc write longArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readLongArray(array);
} catch(error) {
    console.info("rpc read longArray fail, errorCode " + error.code);
    console.info("rpc read longArray fail, errorMessage" + error.message);
}

readLongArray

readLongArray(): number[]

Reads the long 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

let data = rpc.MessageSequence.create();
try {
    data.writeLongArray([1111, 1112, 1113]);
} catch(error) {
    console.info("rpc write longArray fail, errorCode " + error.code);
    console.info("rpc write longArray fail, errorMessage" + error.message);
}
try {
    let array = data.readLongArray();
    console.log("RpcClient: readLongArray is " + array);
} catch(error) {
    console.info("rpc read longArray fail, errorCode " + error.code);
    console.info("rpc read longArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeFloatArray([1.2, 1.3, 1.4]);
} catch(error) {
    console.info("rpc write floatArray fail, errorCode " + error.code);
    console.info("rpc write floatArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeFloatArray([1.2, 1.3, 1.4]);
}catch(error){
    console.info("rpc write floatArray fail, errorCode " + error.code);
    console.info("rpc write floatArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readFloatArray(array);
} catch(error) {
    console.info("rpc read floatArray fail, errorCode " + error.code);
    console.info("rpc read floatArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeFloatArray([1.2, 1.3, 1.4]);
} catch(error) {
    console.info("rpc write floatArray fail, errorCode " + error.code);
    console.info("rpc write floatArray fail, errorMessage" + error.message);
}
try {
    let array = data.readFloatArray();
    console.log("RpcClient: readFloatArray is " + array);
} catch(error) {
    console.info("rpc read floatArray fail, errorCode " + error.code);
    console.info("rpc read floatArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch(error) {
    console.info("rpc write doubleArray fail, errorCode " + error.code);
    console.info("rpc write doubleArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch(error) {
    console.info("rpc write doubleArray fail, errorCode " + error.code);
    console.info("rpc write doubleArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readDoubleArray(array);
} catch(error) {
    console.info("rpc read doubleArray fail, errorCode " + error.code);
    console.info("rpc read doubleArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeDoubleArray([11.1, 12.2, 13.3]);
} catch(error) {
    console.info("rpc write doubleArray fail, errorCode " + error.code);
    console.info("rpc write doubleArray fail, errorMessage" + error.message);
}
try {
    let array = data.readDoubleArray();
    console.log("RpcClient: readDoubleArray is " + array);
} catch(error) {
    console.info("rpc read doubleArray fail, errorCode " + error.code);
    console.info("rpc read doubleArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeBooleanArray([false, true, false]);
} catch(error) {
    console.info("rpc write booleanArray fail, errorCode " + error.code);
    console.info("rpc write booleanArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeBooleanArray([false, true, false]);
} catch(error) {
    console.info("rpc write booleanArray fail, errorCode " + error.code);
    console.info("rpc write booleanArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readBooleanArray(array);
} catch(error) {
    console.info("rpc read booleanArray fail, errorCode " + error.code);
    console.info("rpc read booleanArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeBooleanArray([false, true, false]);
} catch(error) {
    console.info("rpc write booleanArray fail, errorCode " + error.code);
    console.info("rpc write booleanArray fail, errorMessage" + error.message);
}
try {
    let array = data.readBooleanArray();
    console.log("RpcClient: readBooleanArray is " + array);
} catch(error) {
    console.info("rpc read booleanArray fail, errorCode " + error.code);
    console.info("rpc read booleanArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeCharArray([97, 98, 88]);
} catch(error) {
    console.info("rpc write charArray fail, errorCode " + error.code);
    console.info("rpc write charArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeCharArray([97, 98, 88]);
} catch(error) {
    console.info("rpc write charArray fail, errorCode " + error.code);
    console.info("rpc write charArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    data.readCharArray(array);
} catch(error) {
    console.info("rpc read charArray fail, errorCode " + error.code);
    console.info("rpc read charArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeCharArray([97, 98, 88]);
} catch(error) {
    console.info("rpc write charArray fail, errorCode " + error.code);
    console.info("rpc write charArray fail, errorMessage" + error.message);
}
let array = new Array(3);
try {
    let array = data.readCharArray();
    console.log("RpcClient: readCharArray is " + array);
} catch(error) {
    console.info("rpc read charArray fail, errorCode " + error.code);
    console.info("rpc read charArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeStringArray(["abc", "def"]);
} catch(error) {
    console.info("rpc write stringArray fail, errorCode " + error.code);
    console.info("rpc write stringArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeStringArray(["abc", "def"]);
} catch(error) {
    console.info("rpc write stringArray fail, errorCode " + error.code);
    console.info("rpc write stringArray fail, errorMessage" + error.message);
}
let array = new Array(2);
try {
    data.readStringArray(array);
} catch(error) {
    console.info("rpc read stringArray fail, errorCode " + error.code);
    console.info("rpc read stringArray fail, errorMessage" + error.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

let data = rpc.MessageSequence.create();
try {
    data.writeStringArray(["abc", "def"]);
} catch(error) {
    console.info("rpc write stringArray fail, errorCode " + error.code);
    console.info("rpc write stringArray fail, errorMessage" + error.message);
}
try {
    let array = data.readStringArray();
    console.log("RpcClient: readStringArray is " + array);
} catch(error) {
    console.info("rpc read stringArray fail, errorCode " + error.code);
    console.info("rpc read stringArray fail, errorMessage" + error.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

class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        super(descriptor);
    }

    onRemoteRequest(code, data, reply, option) {
        if (code === 1) {
            console.log("RpcServer: onRemoteRequest called");
            try {
                reply.writeNoException();
            } catch(error) {
                console.info("rpc write no exception fail, errorCode " + error.code);
                console.info("rpc write no exception fail, errorMessage" + error.message);
            }
            return true;
        } else {
            console.log("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";

let proxy;
let connect = {
    onConnect: function(elementName, remoteProxy) {
        console.log("RpcClient: js onConnect called.");
        proxy = remoteProxy;
    },
    onDisconnect: function(elementName) {
        console.log("RpcClient: onDisconnect");
    },
    onFailed: function() {
        console.log("RpcClient: onFailed");
    }
};
let 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);

globalThis.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.

let option = new rpc.MessageOption();
let data = rpc.MessageSequence.create();
let reply = rpc.MessageSequence.create();
data.writeInt(1);
data.writeString("hello");
proxy.sendMessageRequest(1, data, reply, option)
    .then(function(errCode) {
        if (errCode === 0) {
            console.log("sendMessageRequest got result");
            try {
                reply.readException();
            } catch(error) {
                console.info("rpc read exception fail, errorCode " + error.code);
                console.info("rpc read no exception fail, errorMessage" + error.message);
            }
            let msg = reply.readString();
            console.log("RPCTest: reply msg: " + msg);
        } else {
            console.log("RPCTest: sendMessageRequest failed, errCode: " + errCode);
        }
    }).catch(function(e) {
        console.log("RPCTest: sendMessageRequest got exception: " + e.message);
    }).finally (() => {
        console.log("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

class MyParcelable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num);
        messageSequence.writeString(this.str);
        return true;
    }
    unmarshalling(messageSequence) {
        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) {
    console.info("rpc write parcelable array fail, errorCode " + error.code);
    console.info("rpc write parcelable array fail, errorMessage" + error.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

class MyParcelable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageSequence) {
        messageSequence.writeInt(this.num);
        messageSequence.writeString(this.str);
        return true;
    }
    unmarshalling(messageSequence) {
        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();
let result = data.writeParcelableArray(a);
console.log("RpcClient: writeParcelableArray is " + result);
let b = [new MyParcelable(0, ""), new MyParcelable(0, ""), new MyParcelable(0, "")];
try {
    data.readParcelableArray(b);
} catch(error) {
    console.info("rpc read parcelable array fail, errorCode " + error.code);
    console.info("rpc read parcelable array fail, errorMessage" + error.message);
}
data.readParcelableArray(b);

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

class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        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();
let result = data.writeRemoteObjectArray(a);
try {
    data.writeRemoteObjectArray(a);
} catch(error) {
    console.info("rpc write remote object array fail, errorCode " + error.code);
    console.info("rpc write remote object array fail, errorMessage" + error.message);
}
console.log("RpcClient: writeRemoteObjectArray is " + result);

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

class MyDeathRecipient {
    onRemoteDied() {
        console.log("server died");
    }
}
class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        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 = new Array(3);
try {
    data.readRemoteObjectArray(b);
} catch(error) {
    console.info("rpc read remote object array fail, errorCode " + error.code);
    console.info("rpc read remote object array fail, errorMessage" + error.message);
}
data.readRemoteObjectArray(b);

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

class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        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();
    console.log("RpcClient: readRemoteObjectArray is " + b);
} catch(error) {
    console.info("rpc read remote object array fail, errorCode " + error.code);
    console.info("rpc read remote object array fail, errorMessage" + error.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';
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) {
    console.info("rpc close file descriptor fail, errorCode " + error.code);
    console.info("rpc close file descriptor fail, errorMessage" + error.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';
let filePath = "path/to/file";
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
    let newFd = rpc.MessageSequence.dupFileDescriptor(file.fd);
} catch(error) {
    console.info("rpc dup file descriptor fail, errorCode " + error.code);
    console.info("rpc dup file descriptor fail, errorMessage" + error.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';
let sequence = new rpc.MessageSequence();
let filePath = "path/to/file";
let r1 = sequence.containFileDescriptors();
let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
try {
    sequence.writeFileDescriptor(file.fd);
} catch(error) {
    console.info("rpc write file descriptor fail, errorCode " + error.code);
    console.info("rpc write file descriptor fail, errorMessage" + error.message);
}
try {
    let containFD = sequence.containFileDescriptors();
    console.log("RpcTest: sequence after write fd containFd result is : " + containFD);
} catch(error) {
    console.info("rpc contain file descriptor fail, errorCode " + error.code);
    console.info("rpc contain file descriptor fail, errorMessage" + error.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';
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) {
    console.info("rpc write file descriptor fail, errorCode " + error.code);
    console.info("rpc write file descriptor fail, errorMessage" + error.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';
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) {
    console.info("rpc write file descriptor fail, errorCode " + error.code);
    console.info("rpc write file descriptor fail, errorMessage" + error.message);
}
try {
    let readFD = sequence.readFileDescriptor();
} catch(error) {
    console.info("rpc read file descriptor fail, errorCode " + error.code);
    console.info("rpc read file descriptor fail, errorMessage" + error.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

let sequence = new rpc.MessageSequence();
let ashmem;
try {
    ashmem = rpc.Ashmem.create("ashmem", 1024);
} catch(error) {
    console.info("rpc create ashmem fail, errorCode " + error.code);
    console.info("rpc creat ashmem fail, errorMessage" + error.message);
}
try {
    sequence.writeAshmem(ashmem);
} catch(error) {
    console.info("rpc write ashmem fail, errorCode " + error.code);
    console.info("rpc write ashmem fail, errorMessage" + error.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

let sequence = new rpc.MessageSequence();
let ashmem;
try {
    ashmem = rpc.Ashmem.create("ashmem", 1024);
} catch(error) {
    console.info("rpc create ashmem fail, errorCode " + error.code);
    console.info("rpc creat ashmem fail, errorMessage" + error.message);
}
try {
    sequence.writeAshmem(ashmem);
} catch(error) {
    console.info("rpc write ashmem fail, errorCode " + error.code);
    console.info("rpc write ashmem fail, errorMessage" + error.message);
}
try {
    let readAshmem = sequence.readAshmem();
    console.log("RpcTest: read ashmem to result is : " + readAshmem);
} catch(error) {
    console.info("rpc read ashmem fail, errorCode " + error.code);
    console.info("rpc read ashmem fail, errorMessage" + error.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

let sequence = new rpc.MessageSequence();
let result = sequence.getRawDataCapacity();
console.log("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

let sequence = new rpc.MessageSequence();
let arr = [1, 2, 3, 4, 5];
try {
    sequence.writeRawData(arr, arr.length);
} catch(error) {
    console.info("rpc write rawdata fail, errorCode " + error.code);
    console.info("rpc write rawdata fail, errorMessage" + error.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

let sequence = new rpc.MessageSequence();
let arr = [1, 2, 3, 4, 5];
try {
    sequence.writeRawData(arr, arr.length);
} catch(error) {
    console.info("rpc write rawdata fail, errorCode " + error.code);
    console.info("rpc write rawdata fail, errorMessage" + error.message);
}
try {
    let result = sequence.readRawData(5);
    console.log("RpcTest: sequence read raw data result is : " + result);
} catch(error) {
    console.info("rpc read rawdata fail, errorCode " + error.code);
    console.info("rpc read rawdata fail, errorMessage" + error.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

let data = rpc.MessageParcel.create();
console.log("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

class MyDeathRecipient {
    onRemoteDied() {
        console.log("server died");
    }
}
class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        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

class MyDeathRecipient {
    onRemoteDied() {
        console.log("server died");
    }
}
class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        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();

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

let data = rpc.MessageParcel.create();
let result = data.writeInterfaceToken("aaa");
console.log("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

class Stub extends rpc.RemoteObject {
    onRemoteMessageRequest(code, data, reply, option) {
        let interfaceToken = data.readInterfaceToken();
        console.log("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

let data = rpc.MessageParcel.create();
let size = data.getSize();
console.log("RpcClient: size is " + size);

getCapacity

getCapacity(): number

Obtains the capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.getCapacity();
console.log("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

let data = rpc.MessageParcel.create();
let setSize = data.setSize(16);
console.log("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

let data = rpc.MessageParcel.create();
let result = data.setCapacity(100);
console.log("RpcClient: setCapacity is " + result);

getWritableBytes

getWritableBytes(): number

Obtains the writable capacity of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

class Stub extends rpc.RemoteObject {
    onRemoteMessageRequest(code, data, reply, option) {
        let getWritableBytes = data.getWritableBytes();
        console.log("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

class Stub extends rpc.RemoteObject {
    onRemoteRequest(code, data, reply, option) {
        let result = data.getReadableBytes();
        console.log("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

let data = rpc.MessageParcel.create();
let readPos = data.getReadPosition();
console.log("RpcClient: readPos is " + readPos);

getWritePosition

getWritePosition(): number

Obtains the write position of this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
data.writeInt(10);
let bwPos = data.getWritePosition();
console.log("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

let data = rpc.MessageParcel.create();
data.writeInt(12);
data.writeString("parcel");
let number = data.readInt();
console.log("RpcClient: number is " + number);
data.rewindRead(0);
let number2 = data.readInt();
console.log("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

let data = rpc.MessageParcel.create();
data.writeInt(4);
data.rewindWrite(0);
data.writeInt(5);
let number = data.readInt();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeByte(2);
console.log("RpcClient: writeByte is: " + result);

readByte

readByte(): number

Reads the Byte value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeByte(2);
console.log("RpcClient: writeByte is: " + result);
let ret = data.readByte();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeShort(8);
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeShort(8);
console.log("RpcClient: writeShort is: " + result);
let ret = data.readShort();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeInt(10);
console.log("RpcClient: writeInt is " + result);

readInt

readInt(): number

Reads the Int value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeInt(10);
console.log("RpcClient: writeInt is " + result);
let ret = data.readInt();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeLong(10000);
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeLong(10000);
console.log("RpcClient: writeLong is " + result);
let ret = data.readLong();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeFloat(1.2);
console.log("RpcClient: writeFloat is " + result);

readFloat

readFloat(): number

Reads the Float value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeFloat(1.2);
console.log("RpcClient: writeFloat is " + result);
let ret = data.readFloat();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeDouble(10.2);
console.log("RpcClient: writeDouble is " + result);

readDouble

readDouble(): number

Reads the Double value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeDouble(10.2);
console.log("RpcClient: writeDouble is " + result);
let ret = data.readDouble();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeBoolean(false);
console.log("RpcClient: writeBoolean is " + result);

readBoolean

readBoolean(): boolean

Reads the Boolean value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeBoolean(false);
console.log("RpcClient: writeBoolean is " + result);
let ret = data.readBoolean();
console.log("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

let data = rpc.MessageParcel.create();
let result = data.writeChar(97);
console.log("RpcClient: writeChar is " + result);

readChar

readChar(): number

Reads the Char value from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeChar(97);
console.log("RpcClient: writeChar is " + result);
let ret = data.readChar();
console.log("RpcClient: readChar is " + ret);

writeString

writeString(val: string): boolean

Writes a string to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeString('abc');
console.log("RpcClient: writeString  is " + result);

readString

readString(): string

Reads the string from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeString('abc');
console.log("RpcClient: writeString  is " + result);
let ret = data.readString();
console.log("RpcClient: readString is " + ret);

writeSequenceable

writeSequenceable(val: Sequenceable): boolean

Writes a sequenceable object to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

class MySequenceable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageParcel) {
        messageParcel.writeInt(this.num);
        messageParcel.writeString(this.str);
        return true;
    }
    unmarshalling(messageParcel) {
        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);
console.log("RpcClient: writeSequenceable is " + result);

readSequenceable

readSequenceable(dataIn: Sequenceable): boolean

Reads member variables from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

class MySequenceable {
    num: number;
    str: string;
    constructor(num, str) {
        this.num = num;
        this.str = str;
    }
    marshalling(messageParcel) {
        messageParcel.writeInt(this.num);
        messageParcel.writeString(this.str);
        return true;
    }
    unmarshalling(messageParcel) {
        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);
console.log("RpcClient: writeSequenceable is " + result);
let ret = new MySequenceable(0, "");
let result2 = data.readSequenceable(ret);
console.log("RpcClient: writeSequenceable is " + result2);

writeByteArray

writeByteArray(byteArray: number[]): boolean

Writes a byte array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
let result = data.writeByteArray(ByteArrayVar);
console.log("RpcClient: writeByteArray is " + result);

readByteArray

readByteArray(dataIn: number[]): void

Reads a byte array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
let result = data.writeByteArray(ByteArrayVar);
console.log("RpcClient: writeByteArray is " + result);
let array = new Array(5);
data.readByteArray(array);

readByteArray

readByteArray(): number[]

Reads the byte array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let ByteArrayVar = [1, 2, 3, 4, 5];
let result = data.writeByteArray(ByteArrayVar);
console.log("RpcClient: writeByteArray is " + result);
let array = data.readByteArray();
console.log("RpcClient: readByteArray is " + array);

writeShortArray

writeShortArray(shortArray: number[]): boolean

Writes a short array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeShortArray([11, 12, 13]);
console.log("RpcClient: writeShortArray is " + result);

readShortArray

readShortArray(dataIn: number[]): void

Reads a short array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeShortArray([11, 12, 13]);
console.log("RpcClient: writeShortArray is " + result);
let array = new Array(3);
data.readShortArray(array);

readShortArray

readShortArray(): number[]

Reads the short array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeShortArray([11, 12, 13]);
console.log("RpcClient: writeShortArray is " + result);
let array = data.readShortArray();
console.log("RpcClient: readShortArray is " + array);

writeIntArray

writeIntArray(intArray: number[]): boolean

Writes an integer array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeIntArray([100, 111, 112]);
console.log("RpcClient: writeIntArray is " + result);

readIntArray

readIntArray(dataIn: number[]): void

Reads an integer array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeIntArray([100, 111, 112]);
console.log("RpcClient: writeIntArray is " + result);
let array = new Array(3);
data.readIntArray(array);

readIntArray

readIntArray(): number[]

Reads the integer array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeIntArray([100, 111, 112]);
console.log("RpcClient: writeIntArray is " + result);
let array = data.readIntArray();
console.log("RpcClient: readIntArray is " + array);

writeLongArray

writeLongArray(longArray: number[]): boolean

Writes a long array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeLongArray([1111, 1112, 1113]);
console.log("RpcClient: writeLongArray is " + result);

readLongArray

readLongArray(dataIn: number[]): void

Reads a long array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeLongArray([1111, 1112, 1113]);
console.log("RpcClient: writeLongArray is " + result);
let array = new Array(3);
data.readLongArray(array);

readLongArray

readLongArray(): number[]

Reads the long array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeLongArray([1111, 1112, 1113]);
console.log("RpcClient: writeLongArray is " + result);
let array = data.readLongArray();
console.log("RpcClient: readLongArray is " + array);

writeFloatArray

writeFloatArray(floatArray: number[]): boolean

Writes a FloatArray to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeFloatArray([1.2, 1.3, 1.4]);
console.log("RpcClient: writeFloatArray is " + result);

readFloatArray

readFloatArray(dataIn: number[]): void

Reads a FloatArray from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeFloatArray([1.2, 1.3, 1.4]);
console.log("RpcClient: writeFloatArray is " + result);
let array = new Array(3);
data.readFloatArray(array);

readFloatArray

readFloatArray(): number[]

Reads the FloatArray from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeFloatArray([1.2, 1.3, 1.4]);
console.log("RpcClient: writeFloatArray is " + result);
let array = data.readFloatArray();
console.log("RpcClient: readFloatArray is " + array);

writeDoubleArray

writeDoubleArray(doubleArray: number[]): boolean

Writes a DoubleArray to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeDoubleArray([11.1, 12.2, 13.3]);
console.log("RpcClient: writeDoubleArray is " + result);

readDoubleArray

readDoubleArray(dataIn: number[]): void

Reads a DoubleArray from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeDoubleArray([11.1, 12.2, 13.3]);
console.log("RpcClient: writeDoubleArray is " + result);
let array = new Array(3);
data.readDoubleArray(array);

readDoubleArray

readDoubleArray(): number[]

Reads the DoubleArray from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeDoubleArray([11.1, 12.2, 13.3]);
console.log("RpcClient: writeDoubleArray is " + result);
let array = data.readDoubleArray();
console.log("RpcClient: readDoubleArray is " + array);

writeBooleanArray

writeBooleanArray(booleanArray: boolean[]): boolean

Writes a Boolean array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeBooleanArray([false, true, false]);
console.log("RpcClient: writeBooleanArray is " + result);

readBooleanArray

readBooleanArray(dataIn: boolean[]): void

Reads a Boolean array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeBooleanArray([false, true, false]);
console.log("RpcClient: writeBooleanArray is " + result);
let array = new Array(3);
data.readBooleanArray(array);

readBooleanArray

readBooleanArray(): boolean[]

Reads the Boolean array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeBooleanArray([false, true, false]);
console.log("RpcClient: writeBooleanArray is " + result);
let array = data.readBooleanArray();
console.log("RpcClient: readBooleanArray is " + array);

writeCharArray

writeCharArray(charArray: number[]): boolean

Writes a character array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeCharArray([97, 98, 88]);
console.log("RpcClient: writeCharArray is " + result);

readCharArray

readCharArray(dataIn: number[]): void

Reads a character array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeCharArray([97, 98, 99]);
console.log("RpcClient: writeCharArray is " + result);
let array = new Array(3);
data.readCharArray(array);

readCharArray

readCharArray(): number[]

Reads the character array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeCharArray([97, 98, 99]);
console.log("RpcClient: writeCharArray is " + result);
let array = data.readCharArray();
console.log("RpcClient: readCharArray is " + array);

writeStringArray

writeStringArray(stringArray: string[]): boolean

Writes a string array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeStringArray(["abc", "def"]);
console.log("RpcClient: writeStringArray is " + result);

readStringArray

readStringArray(dataIn: string[]): void

Reads a string array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Example

let data = rpc.MessageParcel.create();
let result = data.writeStringArray(["abc", "def"]);
console.log("RpcClient: writeStringArray is " + result);
let array = new Array(2);
data.readStringArray(array);

readStringArray

readStringArray(): string[]

Reads the string array from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Return value

Example

let data = rpc.MessageParcel.create();
let result = data.writeStringArray(["abc", "def"]);
console.log("RpcClient: writeStringArray is " + result);
let array = data.readStringArray();
console.log("RpcClient: readStringArray is " + array);

writeNoException⁸⁺

writeNoException(): void

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

System capability: SystemCapability.Communication.IPC.Core

Example

class MyDeathRecipient {
    onRemoteDied() {
        console.log("server died");
    }
}
class TestRemoteObject extends rpc.RemoteObject {
    constructor(descriptor) {
        super(descriptor);
    }
    addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
        return true;
    }
    removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean {
        return true;
    }
    isObjectDead(): boolean {
        return false;
    }
    onRemoteRequest(code, data, reply, option) {
        if (code === 1) {
            console.log("RpcServer: onRemoteRequest called");
            reply.writeNoException();
            return true;
        } else {
            console.log("RpcServer: unknown code: " + code);
            return false;
        }
    }
}

readException⁸⁺

readException(): void

Reads the exception information from this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

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";

let proxy;
let connect = {
    onConnect: function(elementName, remoteProxy) {
        console.log("RpcClient: js onConnect called.");
        proxy = remoteProxy;
    },
    onDisconnect: function(elementName) {
        console.log("RpcClient: onDisconnect");
    },
    onFailed: function() {
        console.log("RpcClient: onFailed");
    }
};
let 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);

globalThis.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.

let option = new rpc.MessageOption();
let data = rpc.MessageParcel.create();
let reply = rpc.MessageParcel.create();
data.writeInt(1);
data.writeString("hello");
proxy.sendMessageRequest(1, data, reply, option)
    .then(function(errCode) {
        if (errCode === 0) {
            console.log("sendMessageRequest got result");
            reply.readException();
            let msg = reply.readString();
            console.log("RPCTest: reply msg: " + msg);
        } else {
            console.log("RPCTest: sendMessageRequest failed, errCode: " + errCode);
        }
    }).catch(function(e) {
        console.log("RPCTest: sendMessageRequest got exception: " + e.message);
    }).finally (() => {
        console.log("RPCTest: sendMessageRequest ends, reclaim parcel");
        data.reclaim();
        reply.reclaim();
    });

writeSequenceableArray

writeSequenceableArray(sequenceableArray: Sequenceable[]): boolean

Writes a sequenceable array to this MessageParcel object.

System capability: SystemCapability.Communication.IPC.Core

Parameters

Return value