| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| /** |
| * @addtogroup NdkBinder |
| * @{ |
| */ |
| |
| /** |
| * @file binder_parcel.h |
| * @brief A collection of data that can be sent as a single packet. |
| */ |
| |
| #pragma once |
| |
| #include <sys/cdefs.h> |
| |
| #include <android/binder_status.h> |
| |
| struct AIBinder; |
| typedef struct AIBinder AIBinder; |
| |
| __BEGIN_DECLS |
| #if __ANDROID_API__ >= __ANDROID_API_Q__ |
| |
| /** |
| * This object represents a package of data that can be sent between processes. When transacting, an |
| * instance of it is automatically created to be used for the transaction. When two processes use |
| * binder to communicate, they must agree on a format of this parcel to be used in order to transfer |
| * data. This is usually done in an IDL (see AIDL, specificially). |
| */ |
| struct AParcel; |
| typedef struct AParcel AParcel; |
| |
| /** |
| * Cleans up a parcel. |
| * |
| * \param parcel A parcel returned by AIBinder_prepareTransaction or AIBinder_transact when a |
| * transaction is being aborted. |
| */ |
| void AParcel_delete(AParcel* parcel) __INTRODUCED_IN(29); |
| |
| /** |
| * Sets the position within the parcel. |
| * |
| * \param parcel The parcel of which to set the position. |
| * \param position Position of the parcel to set. This must be a value returned by |
| * AParcel_getDataPosition. Positions are constant for a given parcel between processes. |
| * |
| * \return STATUS_OK on success. If position is negative, then STATUS_BAD_VALUE will be returned. |
| */ |
| binder_status_t AParcel_setDataPosition(const AParcel* parcel, int32_t position) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Gets the current position within the parcel. |
| * |
| * \param parcel The parcel of which to get the position. |
| * |
| * \return The size of the parcel. This will always be greater than 0. The values returned by this |
| * function before and after calling various reads and writes are not defined. Only the delta |
| * between two positions between a specific sequence of calls is defined. For instance, if position |
| * is X, writeBool is called, and then position is Y, readBool can be called from position X will |
| * return the same value, and then position will be Y. |
| */ |
| int32_t AParcel_getDataPosition(const AParcel* parcel) __INTRODUCED_IN(29); |
| |
| /** |
| * This is called to allocate a buffer for a C-style string (null-terminated). The returned buffer |
| * should be at least length bytes. This includes space for a null terminator. For a string, length |
| * will always be strictly less than or equal to the maximum size that can be held in a size_t and |
| * will always be greater than 0. However, if a 'null' string is being read, length will be -1. |
| * |
| * See also AParcel_readString. |
| * |
| * If allocation fails, null should be returned. |
| * |
| * \param stringData some external representation of a string |
| * \param length the length of the buffer needed to fill (including the null-terminator) |
| * \param buffer a buffer of size 'length' or null if allocation failed. |
| * |
| * \return true if the allocation succeeded, false otherwise. If length is -1, a true return here |
| * means that a 'null' value (or equivalent) was successfully stored. |
| */ |
| typedef bool (*AParcel_stringAllocator)(void* stringData, int32_t length, char** buffer); |
| |
| /** |
| * This is called to allocate an array of size 'length'. If length is -1, then a 'null' array (or |
| * equivalent) should be created. |
| * |
| * See also AParcel_readStringArray |
| * |
| * \param arrayData some external representation of an array |
| * \param length the length to allocate this array to |
| * |
| * \return true if allocation succeeded. If length is -1, a true return here means that a 'null' |
| * value (or equivalent) was successfully stored. |
| */ |
| typedef bool (*AParcel_stringArrayAllocator)(void* arrayData, int32_t length); |
| |
| /** |
| * This is called to allocate a string inside of an array that was allocated by an |
| * AParcel_stringArrayAllocator. |
| * |
| * The index returned will always be within the range [0, length of arrayData). The returned buffer |
| * should be at least length bytes. This includes space for a null-terminator. For a string, length |
| * will always be strictly less than or equal to the maximum size that can be held in a size_t and |
| * will always be greater than 0. However, if a 'null' string is being read, length will be -1. |
| * |
| * See also AParcel_readStringArray |
| * |
| * \param arrayData some external representation of an array. |
| * \param index the index at which a string should be allocated. |
| * \param length the length of the string to be allocated at this index. See also |
| * AParcel_stringAllocator. This includes the length required for a null-terminator. |
| * \param buffer a buffer of size 'length' or null if allocation failed. |
| * |
| * \return true if the allocation succeeded, false otherwise. If length is -1, a true return here |
| * means that a 'null' value (or equivalent) was successfully stored. |
| */ |
| typedef bool (*AParcel_stringArrayElementAllocator)(void* arrayData, size_t index, int32_t length, |
| char** buffer); |
| |
| /** |
| * This returns the length and buffer of an array at a specific index in an arrayData object. |
| * |
| * See also AParcel_writeStringArray |
| * |
| * \param arrayData some external representation of an array. |
| * \param index the index at which a string should be allocated. |
| * \param outLength an out parameter for the length of the string at the specified index. This |
| * should not include the length for a null-terminator if there is one. If the object at this index |
| * is 'null', then this should be set to -1. |
| * |
| * \param a buffer of size outLength or more representing the string at the provided index. This is |
| * not required to be null-terminated. If the object at index is null, then this should be null. |
| */ |
| typedef const char* (*AParcel_stringArrayElementGetter)(const void* arrayData, size_t index, |
| size_t* outLength); |
| |
| // @START-PRIMITIVE-VECTOR-GETTERS |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readInt32Array |
| * |
| * \param arrayData some external representation of an array of int32_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of int32_t of size 'length' (if length is >= 0, if length is 0, this |
| * may be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_int32ArrayAllocator)(void* arrayData, int32_t length, int32_t** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readUint32Array |
| * |
| * \param arrayData some external representation of an array of uint32_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of uint32_t of size 'length' (if length is >= 0, if length is 0, this |
| * may be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_uint32ArrayAllocator)(void* arrayData, int32_t length, uint32_t** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readInt64Array |
| * |
| * \param arrayData some external representation of an array of int64_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of int64_t of size 'length' (if length is >= 0, if length is 0, this |
| * may be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_int64ArrayAllocator)(void* arrayData, int32_t length, int64_t** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readUint64Array |
| * |
| * \param arrayData some external representation of an array of uint64_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of uint64_t of size 'length' (if length is >= 0, if length is 0, this |
| * may be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_uint64ArrayAllocator)(void* arrayData, int32_t length, uint64_t** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readFloatArray |
| * |
| * \param arrayData some external representation of an array of float. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of float of size 'length' (if length is >= 0, if length is 0, this may |
| * be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_floatArrayAllocator)(void* arrayData, int32_t length, float** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readDoubleArray |
| * |
| * \param arrayData some external representation of an array of double. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of double of size 'length' (if length is >= 0, if length is 0, this may |
| * be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_doubleArrayAllocator)(void* arrayData, int32_t length, double** outBuffer); |
| |
| /** |
| * This allocates an array of size 'length' inside of arrayData and returns whether or not there was |
| * a success. If length is -1, then this should allocate some representation of a null array. |
| * |
| * See also AParcel_readBoolArray |
| * |
| * \param arrayData some external representation of an array of bool. |
| * \param length the length to allocate arrayData to (or -1 if this represents a null array). |
| * |
| * \return whether the allocation succeeded. |
| */ |
| typedef bool (*AParcel_boolArrayAllocator)(void* arrayData, int32_t length); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object at index. |
| * |
| * See also AParcel_writeBoolArray |
| * |
| * \param arrayData some external representation of an array of bool. |
| * \param index the index of the value to be retrieved. |
| * |
| * \return the value of the array at index index. |
| */ |
| typedef bool (*AParcel_boolArrayGetter)(const void* arrayData, size_t index); |
| |
| /** |
| * This is called to set an underlying value in an arrayData object at index. |
| * |
| * See also AParcel_readBoolArray |
| * |
| * \param arrayData some external representation of an array of bool. |
| * \param index the index of the value to be set. |
| * \param value the value to set at index index. |
| */ |
| typedef void (*AParcel_boolArraySetter)(void* arrayData, size_t index, bool value); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readCharArray |
| * |
| * \param arrayData some external representation of an array of char16_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of char16_t of size 'length' (if length is >= 0, if length is 0, this |
| * may be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_charArrayAllocator)(void* arrayData, int32_t length, char16_t** outBuffer); |
| |
| /** |
| * This is called to get the underlying data from an arrayData object. |
| * |
| * The implementation of this function should allocate a contiguous array of size 'length' and |
| * return that underlying buffer to be filled out. If there is an error or length is 0, null may be |
| * returned. If length is -1, this should allocate some representation of a null array. |
| * |
| * See also AParcel_readByteArray |
| * |
| * \param arrayData some external representation of an array of int8_t. |
| * \param length the length to allocate arrayData to. |
| * \param outBuffer a buffer of int8_t of size 'length' (if length is >= 0, if length is 0, this may |
| * be nullptr). |
| * |
| * \return whether or not the allocation was successful (or whether a null array is represented when |
| * length is -1). |
| */ |
| typedef bool (*AParcel_byteArrayAllocator)(void* arrayData, int32_t length, int8_t** outBuffer); |
| |
| // @END-PRIMITIVE-VECTOR-GETTERS |
| |
| /** |
| * Writes an AIBinder to the next location in a non-null parcel. Can be null. This does not take any |
| * refcounts of ownership of the binder from the client. |
| * |
| * \param parcel the parcel to write to. |
| * \param binder the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeStrongBinder(AParcel* parcel, AIBinder* binder) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an AIBinder from the next location in a non-null parcel. One strong ref-count of ownership |
| * is passed to the caller of this function. |
| * |
| * \param parcel the parcel to read from. |
| * \param binder the out parameter for what is read from the parcel. This may be null. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_readStrongBinder(const AParcel* parcel, AIBinder** binder) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes a file descriptor to the next location in a non-null parcel. This does not take ownership |
| * of fd. |
| * |
| * This corresponds to the SDK's android.os.ParcelFileDescriptor. |
| * |
| * \param parcel the parcel to write to. |
| * \param fd the value to write to the parcel (-1 to represent a null ParcelFileDescriptor). |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeParcelFileDescriptor(AParcel* parcel, int fd); |
| |
| /** |
| * Reads an int from the next location in a non-null parcel. |
| * |
| * The returned fd must be closed. |
| * |
| * This corresponds to the SDK's android.os.ParcelFileDescriptor. |
| * |
| * \param parcel the parcel to read from. |
| * \param fd the out parameter for what is read from the parcel (or -1 to represent a null |
| * ParcelFileDescriptor) |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_readParcelFileDescriptor(const AParcel* parcel, int* fd); |
| |
| /** |
| * Writes an AStatus object to the next location in a non-null parcel. |
| * |
| * If the status is considered to be a low-level status and has no additional information other |
| * than a binder_status_t (for instance, if it is created with AStatus_fromStatus), then that |
| * status will be returned from this method and nothing will be written to the parcel. If either |
| * this happens or if writing the status object itself fails, the return value from this function |
| * should be propagated to the client, and AParcel_readStatusHeader shouldn't be called. |
| * |
| * \param parcel the parcel to write to. |
| * \param status the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeStatusHeader(AParcel* parcel, const AStatus* status) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an AStatus from the next location in a non-null parcel. Ownership is passed to the caller |
| * of this function. |
| * |
| * \param parcel the parcel to read from. |
| * \param status the out parameter for what is read from the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_readStatusHeader(const AParcel* parcel, AStatus** status) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes utf-8 string value to the next location in a non-null parcel. |
| * |
| * If length is -1, and string is nullptr, this will write a 'null' string to the parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param string the null-terminated string to write to the parcel, at least of size 'length'. |
| * \param length the length of the string to be written. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeString(AParcel* parcel, const char* string, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Reads and allocates utf-8 string value from the next location in a non-null parcel. |
| * |
| * Data is passed to the string allocator once the string size is known. This size includes the |
| * space for the null-terminator of this string. This allocator returns a buffer which is used as |
| * the output buffer from this read. If there is a 'null' string on the binder buffer, the allocator |
| * will be called with length -1. |
| * |
| * \param parcel the parcel to read from. |
| * \param stringData some external representation of a string. |
| * \param allocator allocator that will be called once the size of the string is known. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_readString(const AParcel* parcel, void* stringData, |
| AParcel_stringAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes utf-8 string array data to the next location in a non-null parcel. |
| * |
| * length is the length of the array. AParcel_stringArrayElementGetter will be called for all |
| * indices in range [0, length) with the arrayData provided here. The string length and buffer |
| * returned from this function will be used to fill out the data from the parcel. If length is -1, |
| * this will write a 'null' string array to the binder buffer. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData some external representation of an array. |
| * \param length the length of the array to be written. |
| * \param getter the callback that will be called for every index of the array to retrieve the |
| * corresponding string buffer. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeStringArray(AParcel* parcel, const void* arrayData, int32_t length, |
| AParcel_stringArrayElementGetter getter) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Reads and allocates utf-8 string array value from the next location in a non-null parcel. |
| * |
| * First, AParcel_stringArrayAllocator will be called with the size of the array to be read where |
| * length is the length of the array to be read from the parcel. Then, for each index i in [0, |
| * length), AParcel_stringArrayElementAllocator will be called with the length of the string to be |
| * read from the parcel. The resultant buffer from each of these calls will be filled according to |
| * the contents of the string that is read. If the string array being read is 'null', this will |
| * instead just pass -1 to AParcel_stringArrayAllocator. |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called with arrayData once the size of the output |
| * array is known. |
| * \param elementAllocator the callback that will be called on every index of arrayData to allocate |
| * the string at that location. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readStringArray(const AParcel* parcel, void* arrayData, |
| AParcel_stringArrayAllocator allocator, |
| AParcel_stringArrayElementAllocator elementAllocator) |
| __INTRODUCED_IN(29); |
| |
| // @START-PRIMITIVE-READ-WRITE |
| /** |
| * Writes int32_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeInt32(AParcel* parcel, int32_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes uint32_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeUint32(AParcel* parcel, uint32_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes int64_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeInt64(AParcel* parcel, int64_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes uint64_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeUint64(AParcel* parcel, uint64_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes float value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeFloat(AParcel* parcel, float value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes double value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeDouble(AParcel* parcel, double value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes bool value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeBool(AParcel* parcel, bool value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes char16_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeChar(AParcel* parcel, char16_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes int8_t value to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param value the value to write to the parcel. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeByte(AParcel* parcel, int8_t value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into int32_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readInt32(const AParcel* parcel, int32_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into uint32_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readUint32(const AParcel* parcel, uint32_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into int64_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readInt64(const AParcel* parcel, int64_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into uint64_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readUint64(const AParcel* parcel, uint64_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into float value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readFloat(const AParcel* parcel, float* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into double value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readDouble(const AParcel* parcel, double* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into bool value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readBool(const AParcel* parcel, bool* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into char16_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readChar(const AParcel* parcel, char16_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads into int8_t value from the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to read from. |
| * \param value the value to read from the parcel. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readByte(const AParcel* parcel, int8_t* value) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of int32_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeInt32Array(AParcel* parcel, const int32_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of uint32_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeUint32Array(AParcel* parcel, const uint32_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of int64_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeInt64Array(AParcel* parcel, const int64_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of uint64_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeUint64Array(AParcel* parcel, const uint64_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of float to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeFloatArray(AParcel* parcel, const float* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of double to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeDoubleArray(AParcel* parcel, const double* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of bool to the next location in a non-null parcel. |
| * |
| * getter(arrayData, i) will be called for each i in [0, length) in order to get the underlying |
| * values to write to the parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData some external representation of an array. |
| * \param length the length of arrayData (or -1 if this represents a null array). |
| * \param getter the callback to retrieve data at specific locations in the array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeBoolArray(AParcel* parcel, const void* arrayData, int32_t length, |
| AParcel_boolArrayGetter getter) __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of char16_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeCharArray(AParcel* parcel, const char16_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Writes an array of int8_t to the next location in a non-null parcel. |
| * |
| * \param parcel the parcel to write to. |
| * \param arrayData an array of size 'length' (or null if length is -1, may be null if length is 0). |
| * \param length the length of arrayData or -1 if this represents a null array. |
| * |
| * \return STATUS_OK on successful write. |
| */ |
| binder_status_t AParcel_writeByteArray(AParcel* parcel, const int8_t* arrayData, int32_t length) |
| __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of int32_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readInt32Array(const AParcel* parcel, void* arrayData, |
| AParcel_int32ArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of uint32_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readUint32Array(const AParcel* parcel, void* arrayData, |
| AParcel_uint32ArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of int64_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readInt64Array(const AParcel* parcel, void* arrayData, |
| AParcel_int64ArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of uint64_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readUint64Array(const AParcel* parcel, void* arrayData, |
| AParcel_uint64ArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of float from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readFloatArray(const AParcel* parcel, void* arrayData, |
| AParcel_floatArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of double from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readDoubleArray(const AParcel* parcel, void* arrayData, |
| AParcel_doubleArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of bool from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. Then, for every i in [0, length), |
| * setter(arrayData, i, x) will be called where x is the value at the associated index. |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * \param setter the callback that will be called to set a value at a specific location in the |
| * array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readBoolArray(const AParcel* parcel, void* arrayData, |
| AParcel_boolArrayAllocator allocator, |
| AParcel_boolArraySetter setter) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of char16_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readCharArray(const AParcel* parcel, void* arrayData, |
| AParcel_charArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| /** |
| * Reads an array of int8_t from the next location in a non-null parcel. |
| * |
| * First, allocator will be called with the length of the array. If the allocation succeeds and the |
| * length is greater than zero, the buffer returned by the allocator will be filled with the |
| * corresponding data |
| * |
| * \param parcel the parcel to read from. |
| * \param arrayData some external representation of an array. |
| * \param allocator the callback that will be called to allocate the array. |
| * |
| * \return STATUS_OK on successful read. |
| */ |
| binder_status_t AParcel_readByteArray(const AParcel* parcel, void* arrayData, |
| AParcel_byteArrayAllocator allocator) __INTRODUCED_IN(29); |
| |
| // @END-PRIMITIVE-READ-WRITE |
| |
| #endif //__ANDROID_API__ >= __ANDROID_API_Q__ |
| __END_DECLS |
| |
| /** @} */ |