* During RPC, the sender can use the write methods provided by {@link MessageParcel} to * write the to-be-sent data into a {@link MessageParcel} object in a specific format, and the receiver can use the * read methods provided by {@link MessageParcel} to read data of the specific format from the * {@link MessageParcel} object. *
*
* The default capacity of a {@link MessageParcel} instance is 200KB. If you want more or less, * use {@link #setCapacity(int)} to change it. *
* Note: Only data of the following data types can be written into or read from a {@link MessageParcel}: byte, * byteArray, short, shortArray, int, intArray, long, longArray, float, floatArray, double, doubleArray, boolean, * booleanArray, char, charArray, String, StringArray, {@link IRemoteObject}, IRemoteObjectArray, * {@link Sequenceable}, and SequenceableArray. * * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 * @useinstead ohos.rpc.MessageSequence */ class MessageParcel { /** * Creates an empty {@link MessageParcel} object. * * @returns { MessageParcel } Return the object created. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ static create(): MessageParcel; /** * Reclaim the {@link MessageParcel} object. * * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ reclaim(): void; /** * Serialize a remote object and writes it to the {@link MessageParcel} object. * * @param { IRemoteObject } object - Remote object to serialize. * @returns { boolean } Return {@code true} if it is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeRemoteObject(object: IRemoteObject): boolean; /** * Reads a remote object from {@link MessageParcel} object. * * @returns { IRemoteObject } Return the remote object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readRemoteObject(): IRemoteObject; /** * Writes an interface token into the {@link MessageParcel} object. * * @param { string } token - Interface descriptor to write. * @returns { boolean } Return {@code true} if the interface token has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeInterfaceToken(token: string): boolean; /** * Reads an interface token from the {@link MessageParcel} object. * * @returns { string } Return a string value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readInterfaceToken(): string; /** * Obtains the size of data (in bytes) contained in the {@link MessageParcel} object. * * @returns { number } Return the size of data contained in the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getSize(): number; /** * Obtains the storage capacity (in bytes) of the {@link MessageParcel} object. * * @returns { number } Return the storage capacity of the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getCapacity(): number; /** * Sets the size of data (in bytes) contained in the {@link MessageParcel} object. *{@code false} is returned if the data size set in this method is greater * than the storage capacity of the {@link MessageParcel}. * * @param { number } size - Indicates the data size of the {@link MessageParcel} object. * @returns { boolean } Return {@code true} if the setting is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ setSize(size: number): boolean; /** * Sets the storage capacity (in bytes) of the {@link MessageParcel} object. *
{@code false} is returned if the capacity set in this method is less than * the size of data contained in the {@link MessageParcel}. * * @param { number } size - Indicates the storage capacity of the {@link MessageParcel} object. * @returns { boolean } Return {@code true} if the setting is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ setCapacity(size: number): boolean; /** * Obtains the writable data space (in bytes) in the {@link MessageParcel} object. *
Writable data space = Storage capacity of the {@link MessageParcel} – Size of data contained * in the {@link MessageParcel}. * * @returns { number } Return the writable data space of the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getWritableBytes(): number; /** * Obtains the readable data space (in bytes) in the {@link MessageParcel} object. *
Readable data space = Size of data contained in the {@link MessageParcel} – Size of data that has been read. * * @returns { number } Return the readable data space of the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getReadableBytes(): number; /** * Obtains the current read position in the {@link MessageParcel} object. * * @returns { number } Return the current read position in the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getReadPosition(): number; /** * Obtains the current write position in the {@link MessageParcel} object. * * @returns { number } Return the current write position in the {@link MessageParcel} object. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ getWritePosition(): number; /** * Changes the current read position in the {@link MessageParcel} object. *
Generally, you are advised not to change the current read position. If you must * change it, change it to an accurate position. Otherwise, the read data may be incorrect. * * @param { number } pos - Indicates the target position to start data reading. * @returns { boolean } Return {@code true} if the read position is changed; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ rewindRead(pos: number): boolean; /** * Changes the current write position in the {@link MessageParcel} object. *
Generally, you are advised not to change the current write position. If you must * change it, change it to an accurate position. Otherwise, the data to be read may be incorrect. * * @param { number } pos - Indicates the target position to start data writing. * @returns { boolean } Return {@code true} if the write position is changed; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ rewindWrite(pos: number): boolean; /** * Writes information to this MessageParcel object indicating that no exception occurred. *
After handling requests, you should call this method before writing any data to reply {@link MessageParcel}. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ writeNoException(): void; /** * Reads the exception information from this MessageParcel object. *
If exception was thrown in server side, it will be thrown here. * This method should be called before reading any data from reply {@link MessageParcel} * if {@link writeNoException} was invoked in server side. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readException(): void; /** * Writes a byte value into the {@link MessageParcel} object. * * @param { number } val - Indicates the byte value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeByte(val: number): boolean; /** * Writes a short integer value into the {@link MessageParcel} object. * * @param { number } val - Indicates the short integer value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeShort(val: number): boolean; /** * Writes an integer value into the {@link MessageParcel} object. * * @param { number } val - Indicates the integer value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeInt(val: number): boolean; /** * Writes a long integer value into the {@link MessageParcel} object. * * @param { number } val - Indicates the long integer value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeLong(val: number): boolean; /** * Writes a floating point value into the {@link MessageParcel} object. * * @param { number } val - Indicates the floating point value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeFloat(val: number): boolean; /** * Writes a double-precision floating point value into the {@link MessageParcel} object. * * @param { number } val - Indicates the double-precision floating point value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeDouble(val: number): boolean; /** * Writes a boolean value into the {@link MessageParcel} object. * * @param { boolean } val - Indicates the boolean value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeBoolean(val: boolean): boolean; /** * Writes a single character value into the {@link MessageParcel} object. * * @param { number } val - Indicates the single character value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeChar(val: number): boolean; /** * Writes a string value into the {@link MessageParcel} object. * * @param { string } val - Indicates the string value to write. * @returns { boolean } Return {@code true} if the value has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeString(val: string): boolean; /** * Writes a {@link Sequenceable} object into the {@link MessageParcel} object. * * @param { Sequenceable } val - Indicates the {@link Sequenceable} object to write. * @returns { boolean } Return {@code true} if the {@link Sequenceable} object has been written into * the {@link MessageParcel}; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeSequenceable(val: Sequenceable): boolean; /** * Writes a byte array into the {@link MessageParcel} object. * * @param { number[] } byteArray - Indicates the byte array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeByteArray(byteArray: number[]): boolean; /** * Writes a short integer array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } shortArray - Indicates the short integer array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeShortArray(shortArray: number[]): boolean; /** * Writes an integer array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } intArray - Indicates the integer array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeIntArray(intArray: number[]): boolean; /** * Writes a long integer array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } longArray - Indicates the long integer array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeLongArray(longArray: number[]): boolean; /** * Writes a floating point array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } floatArray - Indicates the floating point array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeFloatArray(floatArray: number[]): boolean; /** * Writes a double-precision floating point array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } doubleArray - Indicates the double-precision floating point array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeDoubleArray(doubleArray: number[]): boolean; /** * Writes a boolean array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { boolean[] } booleanArray - Indicates the boolean array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeBooleanArray(booleanArray: boolean[]): boolean; /** * Writes a single character array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } charArray - Indicates the single character array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeCharArray(charArray: number[]): boolean; /** * Writes a string array into the {@link MessageParcel} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { string[] } stringArray - Indicates the string array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeStringArray(stringArray: string[]): boolean; /** * Writes a {@link Sequenceable} object array into the {@link MessageParcel} object. * * @param { Sequenceable[] } sequenceableArray - Indicates the {@link Sequenceable} object array to write. * @returns { boolean } Return {@code true} if the array has been written into the {@link MessageParcel}; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ writeSequenceableArray(sequenceableArray: Sequenceable[]): boolean; /** * Writes an array of {@link IRemoteObject} objects to this {@link MessageParcel} object. * * @param { IRemoteObject[] } objectArray - Array of {@link IRemoteObject} objects to write. * @returns { boolean } Return {@code true} if the {@link IRemoteObject} array is successfully written * to the {@link MessageParcel}; * return {@code false} if the {@link IRemoteObject} array is null or fails to be written * to the {@link MessageParcel}. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ writeRemoteObjectArray(objectArray: IRemoteObject[]): boolean; /** * Reads a byte value from the {@link MessageParcel} object. * * @returns { number } Return a byte value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readByte(): number; /** * Reads a short integer value from the {@link MessageParcel} object. * * @returns { number } Return a short integer value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readShort(): number; /** * Reads an integer value from the {@link MessageParcel} object. * * @returns { number } Return an integer value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readInt(): number; /** * Reads a long integer value from the {@link MessageParcel} object. * * @returns { number } Return a long integer value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readLong(): number; /** * Reads a floating point value from the {@link MessageParcel} object. * * @returns { number } Return a floating point value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readFloat(): number; /** * Reads a double-precision floating point value from the {@link MessageParcel} object. * * @returns { number } Return a double-precision floating point value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readDouble(): number; /** * Reads a boolean value from the {@link MessageParcel} object. * * @returns { boolean } Return a boolean value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readBoolean(): boolean; /** * Reads a single character value from the {@link MessageParcel} object. * * @returns { number } Return a single character value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readChar(): number; /** * Reads a string value from the {@link MessageParcel} object. * * @returns { string } Return a string value. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readString(): string; /** * Reads a {@link Sequenceable} object from the {@link MessageParcel} instance. * * @param { Sequenceable } dataIn - Indicates the {@link Sequenceable} object that needs to perform * the {@code unmarshalling} operation using the {@link MessageParcel}. * @returns { boolean } Return {@code true} if the unmarshalling is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readSequenceable(dataIn: Sequenceable): boolean; /** * Writes a byte array into the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the byte array read from MessageParcel. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readByteArray(dataIn: number[]): void; /** * Reads a byte array from the {@link MessageParcel} object. * * @returns { number[] } Return a byte array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readByteArray(): number[]; /** * Reads a short integer array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the short integer array read from MessageParcel. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readShortArray(dataIn: number[]): void; /** * Reads a short integer array from the {@link MessageParcel} object. * * @returns { number[] } Return a short integer array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readShortArray(): number[]; /** * Reads an integer array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the integer array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readIntArray(dataIn: number[]): void; /** * Reads an integer array from the {@link MessageParcel} object. * * @returns { number[] } Return an integer array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readIntArray(): number[]; /** * Reads a long integer array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the long integer array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readLongArray(dataIn: number[]): void; /** * Reads a long integer array from the {@link MessageParcel} object. * * @returns { number[] } Return a long integer array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readLongArray(): number[]; /** * Reads a floating point array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the floating point array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readFloatArray(dataIn: number[]): void; /** * Reads a floating point array from the {@link MessageParcel} object. * * @returns { number[] } Return a floating point array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readFloatArray(): number[]; /** * Reads a double-precision floating point array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the double-precision floating point array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readDoubleArray(dataIn: number[]): void; /** * Reads a double-precision floating point array from the {@link MessageParcel} object. * * @returns { number[] } Return a double-precision floating point array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readDoubleArray(): number[]; /** * Reads a boolean array from the {@link MessageParcel} object. * * @param { boolean[] } dataIn - Indicates the boolean array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readBooleanArray(dataIn: boolean[]): void; /** * Reads a boolean array from the {@link MessageParcel} object. * * @returns { boolean[] } Return a boolean array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readBooleanArray(): boolean[]; /** * Reads a single character array from the {@link MessageParcel} object. * * @param { number[] } dataIn - Indicates the single character array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readCharArray(dataIn: number[]): void; /** * Reads a single character array from the {@link MessageParcel} object. * * @returns { number[] } Return a single character array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readCharArray(): number[]; /** * Reads a string array from the {@link MessageParcel} object. * * @param { string[] } dataIn - Indicates the string array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readStringArray(dataIn: string[]): void; /** * Reads a string array from the {@link MessageParcel} object. * * @returns { string[] } Return a string array. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ readStringArray(): string[]; /** * Reads the specified {@link Sequenceable} array from this {@link MessageParcel} object. * * @param { Sequenceable[] } sequenceableArray - Sequenceable array to read. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readSequenceableArray(sequenceableArray: Sequenceable[]): void; /** * Reads the specified {@link IRemoteObject} array from this {@link MessageParcel} object. * * @param { IRemoteObject[] } objects - Reads data from this {@link MessageParcel} object to the specified * {@link IRemoteObject} array. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readRemoteObjectArray(objects: IRemoteObject[]): void; /** * Reads {@link IRemoteObject} objects from this {@link MessageParcel} object. * * @returns { IRemoteObject[] } An array of {@link IRemoteObject} objects obtained. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readRemoteObjectArray(): IRemoteObject[]; /** * Closes the specified file descriptor. * * @param { number } fd - File descriptor to be closed. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ static closeFileDescriptor(fd: number): void; /** * Duplicates the specified file descriptor. * * @param { number } fd - File descriptor to be duplicated. * @returns { number } Return a duplicated file descriptor. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ static dupFileDescriptor(fd: number): number; /** * Checks whether this {@link MessageParcel} object contains a file descriptor. * * @returns { boolean } Return {@code true} if the {@link MessageParcel} object contains a file descriptor; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ containFileDescriptors(): boolean; /** * Writes a file descriptor to this {@link MessageParcel} object. * * @param { number } fd - File descriptor to wrote. * @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ writeFileDescriptor(fd: number): boolean; /** * Reads a file descriptor from this {@link MessageParcel} object. * * @returns { number } Return a file descriptor obtained. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readFileDescriptor(): number; /** * Writes an anonymous shared memory object to this {@link MessageParcel} object. * * @param { Ashmem } ashmem - Anonymous shared memory object to wrote. * @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ writeAshmem(ashmem: Ashmem): boolean; /** * Reads the anonymous shared memory object from this {@link MessageParcel} object. * * @returns { Ashmem } Anonymous share object obtained. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readAshmem(): Ashmem; /** * Obtains the maximum amount of raw data that can be sent in a time. * * @returns { number } 128 MB. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ getRawDataCapacity(): number; /** * Writes raw data to this {@link MessageParcel} object. * * @param { number[] } rawData - Raw data to wrote. * @param { number } size - Size of the raw data, in bytes. * @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ writeRawData(rawData: number[], size: number): boolean; /** * Reads raw data from this {@link MessageParcel} object. * * @param { number } size - Size of the raw data to read. * @returns { number[] } Return the raw data obtained, in bytes. * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ readRawData(size: number): number[]; } /** * A data object used for remote procedure call (RPC). *
* During RPC, the sender can use the write methods provided by {@link MessageSequence} to * write the to-be-sent data into a {@link MessageSequence} object in a specific format, and the receiver can use the * read methods provided by {@link MessageSequence} to read data of the specific format from * the {@link MessageSequence} object. *
*
* The default capacity of a {@link MessageSequence} instance is 200KB. If you want more or less, * use {@link #setCapacity(int)} to change it. *
* Note: Only data of the following data types can be written into or read from a {@link MessageSequence}: * byte, byteArray, short, shortArray, int, intArray, long, longArray, float, floatArray, double, doubleArray, * boolean, booleanArray, char, charArray, String, StringArray, {@link IRemoteObject}, IRemoteObjectArray, * {@link Parcelable}, and ParcelableArray. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ class MessageSequence { /** * Creates an empty {@link MessageSequence} object. * * @returns { MessageSequence } Return the object created. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ static create(): MessageSequence; /** * Reclaim the {@link MessageSequence} object. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ reclaim(): void; /** * Serialize a remote object and writes it to the {@link MessageSequence} object. * * @param { IRemoteObject } object - Remote object to serialize. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900008 - proxy or remote object is invalid * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeRemoteObject(object: IRemoteObject): void; /** * Reads a remote object from {@link MessageSequence} object. * * @returns { IRemoteObject } Return the remote object. * @throws { BusinessError } 1900008 - proxy or remote object is invalid * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readRemoteObject(): IRemoteObject; /** * Writes an interface token into the {@link MessageSequence} object. * * @param { string } token - Interface descriptor to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeInterfaceToken(token: string): void; /** * Reads an interface token from the {@link MessageSequence} object. * * @returns { string } Return a string value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readInterfaceToken(): string; /** * Obtains the size of data (in bytes) contained in the {@link MessageSequence} object. * * @returns { number } Return the size of data contained in the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getSize(): number; /** * Obtains the storage capacity (in bytes) of the {@link MessageSequence} object. * * @returns { number } Return the storage capacity of the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getCapacity(): number; /** * Sets the size of data (in bytes) contained in the {@link MessageSequence} object. *{@code false} is returned if the data size set in this method is greater * than the storage capacity of the {@link MessageSequence}. * * @param { number } size - Indicates the data size of the {@link MessageSequence} object. * @throws { BusinessError } 401 - check param failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ setSize(size: number): void; /** * Sets the storage capacity (in bytes) of the {@link MessageSequence} object. *
{@code false} is returned if the capacity set in this method is less than * the size of data contained in the {@link MessageSequence}. * * @param { number } size - Indicates the storage capacity of the {@link MessageSequence} object. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900011 - parcel memory alloc failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ setCapacity(size: number): void; /** * Obtains the writable data space (in bytes) in the {@link MessageSequence} object. *
Writable data space = Storage capacity of the {@link MessageSequence} – Size of data contained in * the {@link MessageSequence}. * * @returns { number } Return the writable data space of the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getWritableBytes(): number; /** * Obtains the readable data space (in bytes) in the {@link MessageSequence} object. *
Readable data space = Size of data contained in the {@link MessageSequence} – Size of data that has been read. * * @returns { number } Return the readable data space of the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getReadableBytes(): number; /** * Obtains the current read position in the {@link MessageSequence} object. * * @returns { number } Return the current read position in the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getReadPosition(): number; /** * Obtains the current write position in the {@link MessageSequence} object. * * @returns { number } Return the current write position in the {@link MessageSequence} object. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getWritePosition(): number; /** * Changes the current read position in the {@link MessageSequence} object. *
Generally, you are advised not to change the current read position. If you must * change it, change it to an accurate position. Otherwise, the read data may be incorrect. * * @param { number } pos - Indicates the target position to start data reading. * @throws { BusinessError } 401 - check param failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ rewindRead(pos: number): void; /** * Changes the current write position in the {@link MessageSequence} object. *
Generally, you are advised not to change the current write position. If you must * change it, change it to an accurate position. Otherwise, the data to be read may be incorrect. * * @param { number } pos - Indicates the target position to start data writing. * @throws { BusinessError } 401 - check param failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ rewindWrite(pos: number): void; /** * Writes information to this MessageSequence object indicating that no exception occurred. *
After handling requests, you should call this method before writing any data to reply * {@link MessageSequence}. * * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeNoException(): void; /** * Reads the exception information from this MessageSequence object. *
If exception was thrown in server side, it will be thrown here. * This method should be called before reading any data from reply {@link MessageSequence} * if {@link writeNoException} was invoked in server side. * * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readException(): void; /** * Writes a byte value into the {@link MessageSequence} object. * * @param { number } val - Indicates the byte value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeByte(val: number): void; /** * Writes a short integer value into the {@link MessageSequence} object. * * @param { number } val - Indicates the short integer value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeShort(val: number): void; /** * Writes an integer value into the {@link MessageSequence} object. * * @param { number } val - Indicates the integer value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeInt(val: number): void; /** * Writes a long integer value into the {@link MessageSequence} object. * * @param { number } val - Indicates the long integer value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeLong(val: number): void; /** * Writes a floating point value into the {@link MessageSequence} object. * * @param { number } val - Indicates the floating point value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeFloat(val: number): void; /** * Writes a double-precision floating point value into the {@link MessageSequence} object. * * @param { number } val - Indicates the double-precision floating point value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeDouble(val: number): void; /** * Writes a boolean value into the {@link MessageSequence} object. * * @param { boolean } val - Indicates the boolean value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeBoolean(val: boolean): void; /** * Writes a single character value into the {@link MessageSequence} object. * * @param { number } val - Indicates the single character value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeChar(val: number): void; /** * Writes a string value into the {@link MessageSequence} object. * * @param { string } val - Indicates the string value to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeString(val: string): void; /** * Writes a {@link Parcelable} object into the {@link MessageSequence} object. * * @param { Parcelable } val - Indicates the {@link Parcelable} object to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeParcelable(val: Parcelable): void; /** * Writes a byte array into the {@link MessageSequence} object. * * @param { number[] } byteArray - Indicates the byte array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeByteArray(byteArray: number[]): void; /** * Writes a short integer array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } shortArray - Indicates the short integer array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeShortArray(shortArray: number[]): void; /** * Writes an integer array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } intArray - Indicates the integer array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeIntArray(intArray: number[]): void; /** * Writes a long integer array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } longArray - Indicates the long integer array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeLongArray(longArray: number[]): void; /** * Writes a floating point array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } floatArray - Indicates the floating point array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeFloatArray(floatArray: number[]): void; /** * Writes a double-precision floating point array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } doubleArray - Indicates the double-precision floating point array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeDoubleArray(doubleArray: number[]): void; /** * Writes a boolean array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { boolean[] } booleanArray - Indicates the boolean array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeBooleanArray(booleanArray: boolean[]): void; /** * Writes a single character array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { number[] } charArray - Indicates the single character array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeCharArray(charArray: number[]): void; /** * Writes a string array into the {@link MessageSequence} object. * Ensure that the data type and size comply with the interface definition. * Otherwise,data may be truncated. * * @param { string[] } stringArray - Indicates the string array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeStringArray(stringArray: string[]): void; /** * Writes a {@link Parcelable} object array into the {@link MessageSequence} object. * * @param { Parcelable[] } parcelableArray - Indicates the {@link Parcelable} object array to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeParcelableArray(parcelableArray: Parcelable[]): void; /** * Writes an array of {@link IRemoteObject} objects to this {@link MessageSequence} object. * * @param { IRemoteObject[] } objectArray - Array of {@link IRemoteObject} objects to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeRemoteObjectArray(objectArray: IRemoteObject[]): void; /** * Reads a byte value from the {@link MessageParcel} object. * * @returns { number } Return a byte value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readByte(): number; /** * Reads a short integer value from the {@link MessageSequence} object. * * @returns { number } Return a short integer value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readShort(): number; /** * Reads an integer value from the {@link MessageSequence} object. * * @returns { number } Return an integer value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readInt(): number; /** * Reads a long integer value from the {@link MessageSequence} object. * * @returns { number } Return a long integer value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readLong(): number; /** * Reads a floating point value from the {@link MessageSequence} object. * * @returns { number } Return a floating point value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readFloat(): number; /** * Reads a double-precision floating point value from the {@link MessageSequence} object. * * @returns { number } Return a double-precision floating point value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readDouble(): number; /** * Reads a boolean value from the {@link MessageSequence} object. * * @returns { boolean } Return a boolean value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readBoolean(): boolean; /** * Reads a single character value from the {@link MessageSequence} object. * * @returns { number } Return a single character value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readChar(): number; /** * Reads a string value from the {@link MessageSequence} object. * * @returns { string } Return a string value. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readString(): string; /** * Reads a {@link Parcelable} object from the {@link MessageSequence} instance. * * @param { Parcelable } dataIn - Indicates the {@link Parcelable} object that needs to perform * the {@code unmarshalling} operation using the {@link MessageSequence}. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @throws { BusinessError } 1900012 - call js callback function failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readParcelable(dataIn: Parcelable): void; /** * Writes a byte array into the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the byte array read from MessageSequence. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readByteArray(dataIn: number[]): void; /** * Reads a byte array from the {@link MessageSequence} object. * * @returns { number[] } Return a byte array. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readByteArray(): number[]; /** * Reads a short integer array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the short integer array read from MessageSequence. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readShortArray(dataIn: number[]): void; /** * Reads a short integer array from the {@link MessageSequence} object. * * @returns { number[] } Return a short integer array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readShortArray(): number[]; /** * Reads an integer array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the integer array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readIntArray(dataIn: number[]): void; /** * Reads an integer array from the {@link MessageSequence} object. * * @returns { number[] } Return an integer array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readIntArray(): number[]; /** * Reads a long integer array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the long integer array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readLongArray(dataIn: number[]): void; /** * Reads a long integer array from the {@link MessageSequence} object. * * @returns { number[] } Return a long integer array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readLongArray(): number[]; /** * Reads a floating point array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the floating point array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readFloatArray(dataIn: number[]): void; /** * Reads a floating point array from the {@link MessageSequence} object. * * @returns { number[] } Return a floating point array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readFloatArray(): number[]; /** * Reads a double-precision floating point array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the double-precision floating point array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readDoubleArray(dataIn: number[]): void; /** * Reads a double-precision floating point array from the {@link MessageSequence} object. * * @returns { number[] } Return a double-precision floating point array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readDoubleArray(): number[]; /** * Reads a boolean array from the {@link MessageSequence} object. * * @param { boolean[] } dataIn - Indicates the boolean array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readBooleanArray(dataIn: boolean[]): void; /** * Reads a boolean array from the {@link MessageSequence} object. * * @returns { boolean[] } Return a boolean array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readBooleanArray(): boolean[]; /** * Reads a single character array from the {@link MessageSequence} object. * * @param { number[] } dataIn - Indicates the single character array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readCharArray(dataIn: number[]): void; /** * Reads a single character array from the {@link MessageSequence} object. * * @returns { number[] } Return a single character array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readCharArray(): number[]; /** * Reads a string array from the {@link MessageSequence} object. * * @param { string[] } dataIn - Indicates the string array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readStringArray(dataIn: string[]): void; /** * Reads a string array from the {@link MessageSequence} object. * * @returns { string[] } Return a string array. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readStringArray(): string[]; /** * Reads the specified {@link Parcelable} array from this {@link MessageSequence} object. * * @param { Parcelable[] } parcelableArray - Parcelable array to read. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @throws { BusinessError } 1900012 - call js callback function failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readParcelableArray(parcelableArray: Parcelable[]): void; /** * Reads the specified {@link IRemoteObject} array from this {@link MessageSequence} object. * * @param { IRemoteObject[] } objects - Reads data from this {@link MessageSequence} object to * the specified {@link IRemoteObject} array. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readRemoteObjectArray(objects: IRemoteObject[]): void; /** * Reads {@link IRemoteObject} objects from this {@link MessageSequence} object. * * @returns { IRemoteObject[] } Return an array of {@link IRemoteObject} objects obtained. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readRemoteObjectArray(): IRemoteObject[]; /** * Closes the specified file descriptor. * * @param { number } fd - File descriptor to be closed. * @throws { BusinessError } 401 - check param failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ static closeFileDescriptor(fd: number): void; /** * Duplicates the specified file descriptor. * * @param { number } fd - File descriptor to be duplicated. * @returns { number } Return a duplicated file descriptor. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900013 - call os dup function failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ static dupFileDescriptor(fd: number): number; /** * Checks whether this {@link MessageSequence} object contains a file descriptor. * * @returns { boolean } Return {@code true} if the {@link MessageSequence} object contains a file descriptor; * return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ containFileDescriptors(): boolean; /** * Writes a file descriptor to this {@link MessageSequence} object. * * @param { number } fd - File descriptor to wrote. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeFileDescriptor(fd: number): void; /** * Reads a file descriptor from this {@link MessageSequence} object. * * @returns { number } Return a file descriptor obtained. * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readFileDescriptor(): number; /** * Writes an anonymous shared memory object to this {@link MessageSequence} object. * * @param { Ashmem } ashmem - Anonymous shared memory object to wrote. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900003 - write to ashmem failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ writeAshmem(ashmem: Ashmem): void; /** * Reads the anonymous shared memory object from this {@link MessageSequence} object. * * @returns { Ashmem } Return the anonymous share object obtained. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900004 - read from ashmem failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ readAshmem(): Ashmem; /** * Obtains the maximum amount of raw data that can be sent in a time. * * @returns { number } 128 MB. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getRawDataCapacity(): number; /** * Writes raw data to this {@link MessageSequence} object. * * @param { number[] } rawData - Raw data to wrote. * @param { number } size - Size of the raw data, in bytes. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 * @deprecated since 11 * @useinstead ohos.rpc.MessageSequence#writeRawDataBuffer */ writeRawData(rawData: number[], size: number): void; /** * Writes raw data to this {@link MessageSequence} object. * * @param { ArrayBuffer } rawData - Raw data to wrote. * @param { number } size - Size of the raw data, in bytes. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 11 */ writeRawDataBuffer(rawData: ArrayBuffer, size: number): void; /** * Reads raw data from this {@link MessageSequence} object. * * @param { number } size - Size of the raw data to read. * @returns { number[] } Return the raw data obtained, in bytes. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 * @deprecated since 11 * @useinstead ohos.rpc.MessageSequence#readRawDataBuffer */ readRawData(size: number): number[]; /** * Reads raw data from this {@link MessageSequence} object. * * @param { number } size - Size of the raw data to read. * @returns { ArrayBuffer } Return the raw data obtained, in bytes. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 11 */ readRawDataBuffer(size: number): ArrayBuffer; /** * Writes the data in an ArrayBuffer object into this {@Link MessageSequence} object. * * @param { ArrayBuffer } buf - Data to write. * @param { TypeCode } typeCode - Type of the ArrayBuffer data to write. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900009 - write data to message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ writeArrayBuffer(buf: ArrayBuffer, typeCode: TypeCode): void; /** * Reads raw data from this {@link MessageSequence} object. * * @param { TypeCode } typeCode - Type of the ArrayBuffer read. * @returns { ArrayBuffer } Returns the Arraybuffer obtained. * @throws { BusinessError } 401 - check param failed * @throws { BusinessError } 1900010 - read data from message sequence failed * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ readArrayBuffer(typeCode: TypeCode): ArrayBuffer; } /** * @typedef Sequenceable * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 * @useinstead ohos.rpc.Parcelable */ interface Sequenceable { /** * Marshal this {@code Sequenceable} object into a {@link MessageParcel}. * * @param { MessageParcel } dataOut - Indicates the {@link MessageParcel} object to which the {@code Sequenceable} * object will be marshalled. * @returns { boolean } Return {@code true} if the marshalling is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ marshalling(dataOut: MessageParcel): boolean; /** * Unmarshal this {@code Sequenceable} object from a {@link MessageParcel}. * * @param { MessageParcel } dataIn - Indicates the {@link MessageParcel} object into which the {@code Sequenceable} * object has been marshalled. * @returns { boolean } Return {@code true} if the unmarshalling is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ unmarshalling(dataIn: MessageParcel): boolean; } /** * @typedef Parcelable * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ /** * During inter-process communication, objects of the class are written to the {@link MessageSequence} and * they are recovered from the {@link MessageSequence}. * * @typedef Parcelable * @syscap SystemCapability.Communication.IPC.Core * @since 11 */ interface Parcelable { /** * Marshal this {@code Parcelable} object into a {@link MessageSequence}. * * @param { MessageSequence } dataOut - Indicates the {@link MessageSequence} object to which the {@code Parcelable} * object will be marshalled. * @returns { boolean } Return {@code true} if the marshalling is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ marshalling(dataOut: MessageSequence): boolean; /** * Unmarshal this {@code Parcelable} object from a {@link MessageSequence}. * * @param { MessageSequence } dataIn - Indicates the {@link MessageSequence} object into * which the {@code Parcelable} object has been marshalled. * @returns { boolean } Return {@code true} if the unmarshalling is successful; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ unmarshalling(dataIn: MessageSequence): boolean; } /** * Defines the response to the request. *
SendRequestResult object contains four members, namely error code of this operation, request code, data parcel * and reply parcel. * * @typedef SendRequestResult * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 * @useinstead ohos.rpc.RequestResult */ interface SendRequestResult { /** * Error code. 0 indicates successful, otherwise it is failed. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ errCode: number; /** * Message code. It is same as the code in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ code: number; /** * MessageParcel object sent to the peer process. * It is the same object in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ data: MessageParcel; /** * MessageParcel object returned by the peer process. * It is the same object in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 8 * @deprecated since 9 */ reply: MessageParcel; } /** * Defines the response to the request. *
SendRequestResult object contains four members, namely error code of this operation, request code, data parcel * and reply parcel. * * @typedef RequestResult * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ interface RequestResult { /** * Error code. 0 indicates successful, otherwise it is failed. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ errCode: number; /** * Message code. It is same as the code in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ code: number; /** * MessageSequence object sent to the peer process. * It is the same object in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ data: MessageSequence; /** * MessageSequence object returned by the peer process. * It is the same object in {@link SendRequest} method. * * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ reply: MessageSequence; } /** * @syscap SystemCapability.Communication.IPC.Core * @since 7 */ /** * Used to query or get interface descriptors, add or remove death notifications, dump object status to * a specific file, and send messages. * * @syscap SystemCapability.Communication.IPC.Core * @since 11 */ abstract class IRemoteObject { /** * Queries the description of an interface. *
A valid {@link IRemoteBroker} object is returned for an interface used by the service provider; * {@code null} is returned for an interface used by the service user, * indicating that the interface is not a local one. * * @param { string } descriptor - Indicates the interface descriptor. * @returns { IRemoteBroker } Return the {@link IRemoteBroker} object bound to the specified interface descriptor. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 * @useinstead ohos.rpc.IRemoteObject#getLocalInterface */ queryLocalInterface(descriptor: string): IRemoteBroker; /** * Queries the description of an interface. *
A valid {@link IRemoteBroker} object is returned for an interface used by the service provider; * {@code null} is returned for an interface used by the service user, * indicating that the interface is not a local one. * * @param { string } descriptor - Indicates the interface descriptor. * @returns { IRemoteBroker } Return the {@link IRemoteBroker} object bound to the specified interface descriptor. * @throws { BusinessError } 401 - check param failed * @syscap SystemCapability.Communication.IPC.Core * @since 9 */ getLocalInterface(descriptor: string): IRemoteBroker; /** * Sends a {@link MessageParcel} message to the peer process in synchronous or asynchronous mode. *
If asynchronous mode is set for {@code option}, a response is returned immediately. * If synchronous mode is set for {@code option}, the interface will wait for a response from the peer process * until the request times out. The user must prepare {@code reply} for receiving the execution result * given by the peer process. * * @param { number } code - Indicates the message code, which is determined by both sides of the communication. * If the interface is generated by the IDL tool, the message code is automatically generated by IDL. * @param { MessageParcel } data - Indicates the {@link MessageParcel} object sent to the peer process. * @param { MessageParcel } reply - Indicates the {@link MessageParcel} object returned by the peer process. * @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages. * @returns { boolean } Return {@code true} if the method is called successfully; return {@code false} otherwise. * @syscap SystemCapability.Communication.IPC.Core * @since 7 * @deprecated since 9 */ sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): boolean; /** * Sends a {@link MessageParcel} message to the peer process in synchronous or asynchronous mode. *
If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel } reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendMessageRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param {MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param {MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel } reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendMessageRequest is returned,
* and the reply message contains the returned information.
*
* @param {number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param { MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback The interface descriptor is a character string.
*
* @returns { string } Return the interface descriptor.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.IRemoteObject#getDescriptor
*/
getInterfaceDescriptor(): string;
/**
* Obtains the interface descriptor of an object.
* The interface descriptor is a character string.
*
* @returns { string } Return the interface descriptor.
* @throws { BusinessError } 1900008 - proxy or remote object is invalid
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
getDescriptor(): string;
/**
* Checks whether an object is dead.
*
* @returns { boolean } Return {@code true} if the object is dead; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
isObjectDead(): boolean;
}
/**
* @typedef IRemoteBroker
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
/**
* Used to define the communication interface of the IPC communication objects.
*
* @typedef IRemoteBroker
* @syscap SystemCapability.Communication.IPC.Core
* @since 11
*/
interface IRemoteBroker {
/**
* Obtains a proxy or remote object. This method must be implemented by its derived classes.
*
* @returns { IRemoteObject } Return the RemoteObject if the caller is a RemoteObject; return the IRemoteObject,
* that is, the holder of this RemoteProxy object, if the caller is a RemoteProxy object.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
asObject(): IRemoteObject;
}
/**
* @typedef DeathRecipient
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
/**
* Used to subscribe to death notifications for remote objects.
*
* When a remote object subscribed to the notification dies, the local end can receive a message and call
* the onRemoteDied operation. The death of a remote object can be caused by the death of the process to which the
* remote object belongs, the shutdown or restart of the device to which the remote object belongs,
* or the death of the remote object when the remote object and the local object belong to different devices,
* and when the remote object leaves the network.
* This method is implemented by the remote service provider. You need to override this method with
* your own service logic when you are using IPC.
*
* @param { number } code - Indicates the service request code sent from the peer end.
* @param { MessageSequence } data - Indicates the {@link MessageParcel} object sent from the peer end.
* @param { MessageSequence } reply - Indicates the response message object sent from the remote service.
* The local service writes the response data to the {@link MessageParcel} object.
* @param { MessageOption } options - Indicates whether the operation is synchronous or asynchronous.
* @returns { boolean | Promise This method is implemented by the remote service provider. You need to override this method with
* your own service logic when you are using IPC.
*
* @param { number } code - Indicates the service request code sent from the peer end.
* @param { MessageParcel } data - Indicates the {@link MessageParcel} object sent from the peer end.
* @param { MessageParcel } reply - Indicates the response message object sent from the remote service.
* The local service writes the response data to the {@link MessageParcel} object.
* @param { MessageOption } options - Indicates whether the operation is synchronous or asynchronous.
* @returns { boolean } Return {@code true} if the operation succeeds; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteObject#onRemoteMessageRequest
*/
onRemoteRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): boolean;
/**
* Sends a request to the peer object.
* If the peer object and {@code RemoteObject} are on the same device, the request is sent by the IPC driver.
* If they are on different devices, the request is sent by the socket driver.
*
* @param { number } code - Indicates the message code of the request.
* @param { MessageParcel } data - Indicates the {@link MessageParcel} object storing the data to be sent.
* @param { MessageParcel } reply - Indicates the {@link MessageParcel} object receiving the response data.
* @param { MessageOption } options - Indicates a synchronous (default) or asynchronous request.
* @returns { boolean } Return {@code true} if the operation succeeds; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 8
*/
sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): boolean;
/**
* Sends a {@link MessageParcel} message to the peer process in synchronous or asynchronous mode.
* If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel } reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendMessageRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param { MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel} reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendMessageRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param { MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback This method is used to change the default descriptor specified during the creation of {@code RemoteObject}.
*
* @param { IRemoteBroker } localInterface - Indicates the {@code RemoteObject} whose descriptor is to be changed.
* @param { string } descriptor - Indicates the new descriptor of the {@code RemoteObject}.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteObject#modifyLocalInterface
*/
attachLocalInterface(localInterface: IRemoteBroker, descriptor: string): void;
/**
* Modifies the description of the current {@code RemoteObject}.
* This method is used to change the default descriptor specified during the creation of {@code RemoteObject}.
*
* @param { IRemoteBroker } localInterface - Indicates the {@code RemoteObject} whose descriptor is to be changed.
* @param { string } descriptor - Indicates the new descriptor of the {@code RemoteObject}.
* @throws { BusinessError } 401 - check param failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
modifyLocalInterface(localInterface: IRemoteBroker, descriptor: string): void;
}
/**
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
/**
* Implement the IRemoteObject proxy object.
*
* @extends IRemoteObject
* @syscap SystemCapability.Communication.IPC.Core
* @since 11
*/
class RemoteProxy extends IRemoteObject {
/**
* Indicates the message code for a Ping operation.
*
* @default 1599098439
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
PING_TRANSACTION: number;
/**
* Indicates the message code for a dump operation.
*
* @default 1598311760
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
DUMP_TRANSACTION: number;
/**
* Indicates the message code for a transmission.
*
* @default 1598968902
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
INTERFACE_TRANSACTION: number;
/**
* Indicates the minimum value of a valid message code.
* This constant is used to check the validity of an operation.
*
* @default 0x1
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
MIN_TRANSACTION_ID: number;
/**
* Indicates the maximum value of a valid message code.
* This constant is used to check the validity of an operation.
*
* @default 0x00FFFFFF
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
MAX_TRANSACTION_ID: number;
/**
* Queries a local interface with a specified descriptor.
*
* @param { string } interface - Indicates the descriptor of the interface to query.
* @returns { IRemoteBroker } Return null by default, indicating a proxy interface.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteProxy#getLocalInterface
*/
queryLocalInterface(interface: string): IRemoteBroker;
/**
* Queries a local interface with a specified descriptor.
*
* @param { string } interface - Indicates the descriptor of the interface to query.
* @returns { IRemoteBroker } Return null by default, indicating a proxy interface.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900006 - only remote object permitted
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
getLocalInterface(interface: string): IRemoteBroker;
/**
* Register a callback used to receive death notifications of a remote object.
*
* @param { DeathRecipient } recipient - Indicates the callback to be registered.
* @param { number } flags - Indicates the flag of the death notification. This is a reserved parameter.
* Set it to {@code 0}.
* @returns { boolean } Return {@code true} if the callback is registered successfully;
* return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteProxy#registerDeathRecipient
*/
addDeathRecipient(recipient: DeathRecipient, flags: number): boolean;
/**
* Register a callback used to receive death notifications of a remote object.
*
* @param { DeathRecipient } recipient - Indicates the callback to be registered.
* @param { number } flags - Indicates the flag of the death notification. This is a reserved parameter.
* Set it to {@code 0}.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900008 - proxy or remote object is invalid
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
registerDeathRecipient(recipient: DeathRecipient, flags: number): void;
/**
* Unregister a callback used to receive death notifications of a remote object.
*
* @param { DeathRecipient } recipient - Indicates the callback to be unregister.
* @param { number } flags - Indicates the flag of the death notification. This is a reserved parameter.
* Set it to {@code 0}.
* @returns { boolean } Return {@code true} if the callback is unregister successfully;
* return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteProxy#unregisterDeathRecipient
*/
removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean;
/**
* Unregister a callback used to receive death notifications of a remote object.
*
* @param { DeathRecipient } recipient - Indicates the callback to be unregister.
* @param { number } flags - Indicates the flag of the death notification. This is a reserved parameter.
* Set it to {@code 0}.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900008 - proxy or remote object is invalid
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
unregisterDeathRecipient(recipient: DeathRecipient, flags: number): void;
/**
* Queries the interface descriptor of remote object.
*
* @returns { string } Return the interface descriptor.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.RemoteProxy#getDescriptor
*/
getInterfaceDescriptor(): string;
/**
* Queries the interface descriptor of remote object.
*
* @returns { string } Return the interface descriptor.
* @throws { BusinessError } 1900007 - communication failed
* @throws { BusinessError } 1900008 - proxy or remote object is invalid
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
getDescriptor(): string;
/**
* Sends a request to the peer object.
* If the peer object and {@code RemoteProxy} are on the same device, the request is sent by the IPC driver.
* If they are on different devices, the request is sent by the socket driver.
*
* @param { number } code - Indicates the message code of the request.
* @param { MessageParcel } data - Indicates the {@link MessageParcel} object storing the data to be sent.
* @param { MessageParcel } reply - Indicates the {@link MessageParcel} object receiving the response data.
* @param { MessageOption } options - Indicates a synchronous (default) or asynchronous request.
* @returns { boolean } Return {@code true} if the operation succeeds; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 8
*/
sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): boolean;
/**
* Sends a {@link MessageParcel} message to the peer process in synchronous or asynchronous mode.
* If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel} reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a promise will be fulfilled immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a promise will be fulfilled when the response to sendMessageRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param { MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @returns { Promise If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageParcel } data - {@link MessageParcel} object holding the data to send.
* @param { MessageParcel } reply - {@link MessageParcel} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback If options indicates the asynchronous mode, a callback will be invoked immediately
* and the reply message does not contain any content. If options indicates the synchronous mode,
* a callback will be invoked when the response to sendRequest is returned,
* and the reply message contains the returned information.
*
* @param { number } code - Message code called by the request, which is determined by the client and server.
* If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool.
* @param { MessageSequence } data - {@link MessageSequence} object holding the data to send.
* @param { MessageSequence } reply - {@link MessageSequence} object that receives the response.
* @param { MessageOption } options - Indicates the synchronous or asynchronous mode to send messages.
* @param { AsyncCallback This method is static.
*
* @returns { IRemoteObject } Return an {@link IRemoteObject} reference of the registered service.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static getContextObject(): IRemoteObject;
/**
* Obtains the PID of a proxy.
* This method is static. The PID is a positive integer during the communication between
* the {@link RemoteProxy} object and {@link RemoteObject} object, and resumes to {@code 0}
* when the communication ends. If this method is called from the {@link RemoteProxy} object,
* {@code 0} is returned; if this method is called from the {@link RemoteObject} object,
* the PID of the corresponding {@link RemoteProxy} object is returned.
*
* @returns { number } Return the PID of the proxy.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static getCallingPid(): number;
/**
* Obtains the UID of a proxy.
* This method is static. The UID is a positive integer during the communication between
* the {@link RemoteProxy} object and {@link RemoteObject} object, and resumes to {@code 0}
* when the communication ends. If this method is called from the {@link RemoteProxy} object,
* {@code 0} is returned; if this method is called from the {@link RemoteObject} object,
* the UID of the corresponding {@link RemoteProxy} object is returned.
*
* @returns { number } Return the UID of the proxy.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static getCallingUid(): number;
/**
* Obtains the TOKENID.
* This method is static.
*
* @returns { number } Return the TOKENID.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
static getCallingTokenId(): number;
/**
* Obtains the ID of the device where the peer process resides.
* This method is static.
*
* @returns { string } Return the ID of the device where the peer process resides.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static getCallingDeviceID(): string;
/**
* Obtains the ID of the local device.
* This method is static.
*
* @returns { string } Return the ID of the local device.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static getLocalDeviceID(): string;
/**
* Checks whether a call is made on the same device.
* This method is static.
*
* @returns { boolean } Return {@code true} if the call is made on the same device; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static isLocalCalling(): boolean;
/**
* Flush all pending commands from a specified {@link RemoteProxy} to the corresponding {@link RemoteObject}.
* This method is static. You are advised to call this method before performing any time-sensitive operations.
*
* @param { IRemoteObject } object - Indicates the specified {@link RemoteProxy}.
* @returns { number } Return {@code 0} if the operation succeeds; return an error code if the input object
* is empty or {@link RemoteObject}, or the operation fails.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.IPCSkeleton#flushCmdBuffer
*/
static flushCommands(object: IRemoteObject): number;
/**
* Flush all pending commands from a specified {@link RemoteProxy} to the corresponding {@link RemoteObject}.
* This method is static. You are advised to call this method before performing any time-sensitive operations.
*
* @param { IRemoteObject } object - Indicates the specified {@link RemoteProxy}.
* @throws { BusinessError } 401 - check param failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
static flushCmdBuffer(object: IRemoteObject): void;
/**
* Replaces the UID and PID of the remote user with those of the local user.
* This method is static. It can be used in scenarios like authentication.
*
* @returns { string } Return a string containing the UID and PID of the remote user.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
*/
static resetCallingIdentity(): string;
/**
* Restore the UID and PID to those of the remote user.
* This method is static. It is usually called after {@code resetCallingIdentity} is used
* and requires the UID and PID of the remote user returned by {@code resetCallingIdentity}.
*
* @param { string } identity - Indicates the string containing the UID and PID of the remote user,
* which is returned by {@code resetCallingIdentity}.
* @returns { boolean } Return {@code true} if the operation succeeds; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.rpc.IPCSkeleton#restoreCallingIdentity
*/
static setCallingIdentity(identity: string): boolean;
/**
* Restore the UID and PID to those of the remote user.
* This method is static. It is usually called after {@code resetCallingIdentity} is used
* and requires the UID and PID of the remote user returned by {@code resetCallingIdentity}.
*
* @param { string } identity - Indicates the string containing the UID and PID of the remote user,
* which is returned by {@code resetCallingIdentity}.
* @throws { BusinessError } 401 - check param failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
static restoreCallingIdentity(identity: string): void;
}
/**
* Provides methods related to anonymous shared memory objects,
* including creating, closing, mapping, and unmapping an Ashmem object,
* reading data from and writing data to an Ashmem object,
* obtaining the Ashmem size, and setting Ashmem protection.
*
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
class Ashmem {
/**
* The mapped memory is executable.
*
* @default 4
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
PROT_EXEC: number;
/**
* The mapped memory is inaccessible.
*
* @default 0
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
PROT_NONE: number;
/**
* The mapped memory is readable.
*
* @default 1
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
PROT_READ: number;
/**
* The mapped memory is writable.
*
* @default 2
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
PROT_WRITE: number;
/**
* Creates an Ashmem object with the specified name and size.
*
* @param { string } name - Name of the Ashmem object to create.
* @param { number } size - Size (in bytes) of the Ashmem object to create.
* @returns { Ashmem } Return the Ashmem object if it is created successfully; return null otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#create
*/
static createAshmem(name: string, size: number): Ashmem;
/**
* Creates an Ashmem object with the specified name and size.
*
* @param { string } name - Name of the Ashmem object to create.
* @param { number } size - Size (in bytes) of the Ashmem object to create.
* @returns { Ashmem } Return the Ashmem object if it is created successfully; return null otherwise.
* @throws { BusinessError } 401 - check param failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
static create(name: string, size: number): Ashmem;
/**
* Creates an Ashmem object by copying the file descriptor (FD) of an existing Ashmem object.
* The two Ashmem objects point to the same shared memory region.
*
* @param { Ashmem } ashmem - Existing Ashmem object.
* @returns { Ashmem } Ashmem object created.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#create
*/
static createAshmemFromExisting(ashmem: Ashmem): Ashmem;
/**
* Creates an Ashmem object by copying the file descriptor (FD) of an existing Ashmem object.
* The two Ashmem objects point to the same shared memory region.
*
* @param { Ashmem } ashmem - Existing Ashmem object.
* @returns { Ashmem } Ashmem object created.
* @throws { BusinessError } 401 - check param failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
static create(ashmem: Ashmem): Ashmem;
/**
* Closes this Ashmem object.
*
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
closeAshmem(): void;
/**
* Deletes the mappings for the specified address range of this Ashmem object.
*
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
unmapAshmem(): void;
/**
* Obtains the mapped memory size of this Ashmem object.
*
* @returns { number } Memory size mapped.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
*/
getAshmemSize(): number;
/**
* Creates the shared file mapping on the virtual address space of this process.
* The size of the mapping region is specified by this Ashmem object.
*
* @param { number } mapType - Protection level of the memory region to which the shared file is mapped.
* @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#mapTypedAshmem
*/
mapAshmem(mapType: number): boolean;
/**
* Creates the shared file mapping on the virtual address space of this process.
* The size of the mapping region is specified by this Ashmem object.
*
* @param { number } mapType - Protection level of the memory region to which the shared file is mapped.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900001 - call mmap function failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
mapTypedAshmem(mapType: number): void;
/**
* Maps the shared file to the readable and writable virtual address space of the process.
*
* @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#mapReadWriteAshmem
*/
mapReadAndWriteAshmem(): boolean;
/**
* Maps the shared file to the readable and writable virtual address space of the process.
*
* @throws { BusinessError } 1900001 - call mmap function failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
mapReadWriteAshmem(): void;
/**
* Maps the shared file to the read-only virtual address space of the process.
*
* @returns { boolean } Return {@code true} if the operation is successful; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#mapReadonlyAshmem
*/
mapReadOnlyAshmem(): boolean;
/**
* Maps the shared file to the read-only virtual address space of the process.
*
* @throws { BusinessError } 1900001 - call mmap function failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
mapReadonlyAshmem(): void;
/**
* Sets the protection level of the memory region to which the shared file is mapped.
*
* @param { number } protectionType - Protection type to set.
* @returns { boolean } Return true if the operation is successful; return false otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#setProtectionType
*/
setProtection(protectionType: number): boolean;
/**
* Sets the protection level of the memory region to which the shared file is mapped.
*
* @param { number } protectionType - Protection type to set.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900002 - os ioctl function failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
*/
setProtectionType(protectionType: number): void;
/**
* Writes data to the shared file associated with this Ashmem object.
*
* @param { number[] } buf - Data to write.
* @param { number } size - Size of the data to write.
* @param { number } offset - Start position of the data to write in the memory region associated
* with this Ashmem object.
* @returns { boolean } Return {@code true} is the data is written successfully; return {@code false} otherwise.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#writeAshmem
*/
writeToAshmem(buf: number[], size: number, offset: number): boolean;
/**
* Writes data to the shared file associated with this Ashmem object.
*
* @param { number[] } buf - Data to write
* @param { number } size - Size of the data to write
* @param { number } offset - Start position of the data to write in the memory region associated
* with this Ashmem object.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900003 - write to ashmem failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
* @deprecated since 11
* @useinstead ohos.rpc.Ashmem#writeDataToAshmem
*/
writeAshmem(buf: number[], size: number, offset: number): void;
/**
* Writes data to the shared file associated with this Ashmem object.
*
* @param { ArrayBuffer } buf - Data to write
* @param { number } size - Size of the data to write
* @param { number } offset - Start position of the data to write in the memory region associated
* with this Ashmem object.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900003 - write to ashmem failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 11
*/
writeDataToAshmem(buf: ArrayBuffer, size: number, offset: number): void;
/**
* Reads data from the shared file associated with this Ashmem object.
*
* @param { number } size - Size of the data to read.
* @param { number } offset - Start position of the data to read in the memory region associated
* with this Ashmem object.
* @returns { number[] } Data read.
* @syscap SystemCapability.Communication.IPC.Core
* @since 8
* @deprecated since 9
* @useinstead ohos.rpc.Ashmem#readAshmem
*/
readFromAshmem(size: number, offset: number): number[];
/**
* Reads data from the shared file associated with this Ashmem object.
*
* @param { number } size - Size of the data to read.
* @param { number } offset - Start position of the data to read in the memory region associated
* with this Ashmem object.
* @returns { number[] } Data read.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900004 - read from ashmem failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 9
* @deprecated since 11
* @useinstead ohos.rpc.Ashmem#readDataFromAshmem
*/
readAshmem(size: number, offset: number): number[];
/**
* Reads data from the shared file associated with this Ashmem object.
*
* @param { number } size - Size of the data to read.
* @param { number } offset - Start position of the data to read in the memory region associated
* with this Ashmem object.
* @returns { ArrayBuffer } Data read.
* @throws { BusinessError } 401 - check param failed
* @throws { BusinessError } 1900004 - read from ashmem failed
* @syscap SystemCapability.Communication.IPC.Core
* @since 11
*/
readDataFromAshmem(size: number, offset: number): ArrayBuffer;
}
}
export default rpc;