進(jìn)程間通信能力

導(dǎo)入模塊

import rpc from '@ohos.rpc';

ErrorCode9+

從API version 9起，IPC支持異常返回功能。錯誤碼對應(yīng)數(shù)值及含義如下。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

MessageSequence9+

在RPC或IPC過程中，發(fā)送方可以使用MessageSequence提供的寫方法，將待發(fā)送的數(shù)據(jù)以特定格式寫入該對象。接收方可以使用MessageSequence提供的讀方法從該對象中讀取特定格式的數(shù)據(jù)。數(shù)據(jù)格式包括：基礎(chǔ)類型及數(shù)組、IPC對象、接口描述符和自定義序列化對象。

create

static create(): MessageSequence

靜態(tài)方法，創(chuàng)建MessageSequence對象。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

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

reclaim

reclaim(): void

釋放不再使用的MessageSequence對象。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

示例：

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

writeRemoteObject

writeRemoteObject(object: IRemoteObject): void

序列化遠(yuǎn)程對象并將其寫入MessageSequence對象。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence讀取遠(yuǎn)程對象。此方法用于反序列化MessageSequence對象以生成IRemoteObject。遠(yuǎn)程對象按寫入MessageSequence的順序讀取。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將接口描述符寫入MessageSequence對象，遠(yuǎn)端對象可使用該信息校驗本次通信。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence對象中讀取接口描述符，接口描述符按寫入MessageSequence的順序讀取，本地對象可使用該信息檢驗本次通信。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

獲取當(dāng)前創(chuàng)建的MessageSequence對象的數(shù)據(jù)大小。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

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

getCapacity

getCapacity(): number

獲取當(dāng)前MessageSequence對象的容量大小。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

let data = rpc.MessageSequence.create();
let result = data.getCapacity();
console.log("RpcClient: capacity is " + result);

setSize

setSize(size: number): void

設(shè)置MessageSequence對象中包含的數(shù)據(jù)大小。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

示例：

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

設(shè)置MessageSequence對象的存儲容量。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

獲取MessageSequence的可寫字節(jié)空間大小。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

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

獲取MessageSequence的可讀字節(jié)空間。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

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

獲取MessageSequence的讀位置。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

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

getWritePosition

getWritePosition(): number

獲取MessageSequence的寫位置。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

示例：

let data = rpc.MessageSequence.create();
data.writeInt(10);
let bwPos = data.getWritePosition();
console.log("RpcClient: bwPos is " + bwPos);

rewindRead

rewindRead(pos: number): void

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

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

示例：

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

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

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

示例：

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

將字節(jié)值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取字節(jié)值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將短整數(shù)值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取短整數(shù)值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將整數(shù)值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取整數(shù)值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將長整數(shù)值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取長整數(shù)值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將浮點值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取浮點值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將雙精度浮點值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取雙精度浮點值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將布爾值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取布爾值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將單個字符值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取單個字符值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將字符串值寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取字符串值。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將自定義序列化對象寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取成員變量到指定的對象（dataIn）。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將字節(jié)數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取字節(jié)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取字節(jié)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將短整數(shù)數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取短整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取短整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將整數(shù)數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將長整數(shù)數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取的長整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取所有的長整數(shù)數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將浮點數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取浮點數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取浮點數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將雙精度浮點數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取雙精度浮點數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取所有雙精度浮點數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將布爾數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取布爾數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取所有布爾數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將單個字符數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例中讀取單個字符數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取單個字符數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將字符串?dāng)?shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取字符串?dāng)?shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取字符串?dāng)?shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

返回值：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

向MessageSequence寫入“指示未發(fā)生異?！钡男畔ⅰ?/p>

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence中讀取異常。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

獲取服務(wù)

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.MainAbility",
};
FA.connectAbility(want, connect);

上述onConnect回調(diào)函數(shù)中的proxy對象需要等ability異步連接成功后才會被賦值，然后才可調(diào)用proxy對象的sendMessageRequest接口方法發(fā)送消息

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

將可序列化對象數(shù)組寫入MessageSequence實例。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence實例讀取可序列化對象數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

將IRemoteObject對象數(shù)組寫入MessageSequence。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：

錯誤碼：

以下錯誤碼的詳細(xì)介紹請參見ohos.rpc錯誤碼

示例：

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

從MessageSequence讀取IRemoteObject對象數(shù)組。

系統(tǒng)能力：SystemCapability.Communication.IPC.Core

參數(shù)：