Skip to content

Commit 66eb630

Browse files
Copilothari22yuva
Copilot
and
hari22yuva
committed
Add general exception handling documentation to all AIDL interface files
Co-authored-by: hari22yuva <56021398+hari22yuva@users.noreply.github.com>
1 parent 81201e8 commit 66eb630

File tree

37 files changed

+275
-17
lines changed

37 files changed

+275
-17
lines changed

‎audiodecoder/current/com/rdk/hal/audiodecoder/IAudioDecoder.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ import com.rdk.hal.PropertyValue;
3232
* @author Luc Kennedy-Lamb
3333
* @author Peter Stieglitz
3434
* @author Douglas Adler
35+
*
36+
* <h3>Exception Handling</h3>
37+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
38+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
39+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
40+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
41+
* The caller must ignore any output variables.
3542
*/
3643

3744
@VintfStability

‎audiodecoder/current/com/rdk/hal/audiodecoder/IAudioDecoderController.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ import com.rdk.hal.PropertyValue;
2727
* @author Luc Kennedy-Lamb
2828
* @author Peter Stieglitz
2929
* @author Douglas Adler
30+
*
31+
* <h3>Exception Handling</h3>
32+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
33+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
34+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
35+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
36+
* The caller must ignore any output variables.
3037
*/
3138

3239
@VintfStability

‎audiodecoder/current/com/rdk/hal/audiodecoder/IAudioDecoderManager.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ import com.rdk.hal.audiodecoder.IAudioDecoder;
2424
* @author Luc Kennedy-Lamb
2525
* @author Peter Stieglitz
2626
* @author Douglas Adler
27+
*
28+
* <h3>Exception Handling</h3>
29+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
30+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
31+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
32+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
33+
* The caller must ignore any output variables.
2734
*/
2835

2936
@VintfStability

‎audiosink/current/com/rdk/hal/audiosink/IAudioSink.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ import com.rdk.hal.State;
3131
* @author Luc Kennedy-Lamb
3232
* @author Peter Stieglitz
3333
* @author Douglas Adler
34+
*
35+
* <h3>Exception Handling</h3>
36+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
37+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
38+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
39+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
40+
* The caller must ignore any output variables.
3441
*/
3542

3643
@VintfStability

‎audiosink/current/com/rdk/hal/audiosink/IAudioSinkController.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ import com.rdk.hal.audiodecoder.FrameMetadata;
2727
* @author Luc Kennedy-Lamb
2828
* @author Peter Stieglitz
2929
* @author Douglas Adler
30+
*
31+
* <h3>Exception Handling</h3>
32+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
33+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
34+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
35+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
36+
* The caller must ignore any output variables.
3037
*/
3138

3239
@VintfStability

‎audiosink/current/com/rdk/hal/audiosink/IAudioSinkManager.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ import com.rdk.hal.audiosink.PlatformCapabilities;
2525
* @author Luc Kennedy-Lamb
2626
* @author Peter Stieglitz
2727
* @author Douglas Adler
28+
*
29+
* <h3>Exception Handling</h3>
30+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
31+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
32+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
33+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
34+
* The caller must ignore any output variables.
2835
*/
2936

3037
@VintfStability

‎avbuffer/current/com/rdk/hal/avbuffer/IAVBuffer.aidl‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ import com.rdk.hal.audiodecoder.IAudioDecoder;
2929
* @author Luc Kennedy-Lamb
3030
* @author Peter Stieglitz
3131
* @author Douglas Adler
32+
*
33+
* <h3>Exception Handling</h3>
34+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
35+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
36+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
37+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
38+
* The caller must ignore any output variables.
3239
*/
3340

3441
@VintfStability
@@ -68,7 +75,7 @@ interface IAVBuffer
6875
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT if videoDecoderIndex is invalid
6976
* @exception binder::Status::Exception::EX_SERVICE_SPECIFIC, HALError::OUT_OF_MEMORY if heap is exhausted
7077
*
71-
* @note On exception, the returned pool handle is an unknown value and must not be used.
78+
* @note On exception, the returned pool handle is an unknown value and must not be used. (See {@link IAVBuffer} for exception handling behavior).
7279
*
7380
* @pre The IVideoDecoder.Id must have been obtained from IVideoDecoderManager.getVideoDecoderIds()
7481
*
@@ -97,7 +104,7 @@ interface IAVBuffer
97104
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT if audioDecoderId is invalid
98105
* @exception binder::Status::Exception::EX_SERVICE_SPECIFIC, HALError::OUT_OF_MEMORY if heap is exhausted
99106
*
100-
* @note On exception, the returned pool handle is an unknown value and must not be used.
107+
* @note On exception, the returned pool handle is an unknown value and must not be used. (See {@link IAVBuffer} for exception handling behavior).
101108
*
102109
* @pre The IAudioDecoder.Id must have been obtained from IAudioDecoderManager.getAudioDecoderIds()
103110
* or IAudioDecoder.Id.UNDEFINED must be used.
@@ -178,7 +185,7 @@ interface IAVBuffer
178185
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT if pool handle is invalid or size is invalid
179186
* @exception binder::Status::Exception::EX_SERVICE_SPECIFIC, HALError::OUT_OF_MEMORY if allocation fails
180187
*
181-
* @note On exception, the returned buffer handle is an unknown value and must not be used.
188+
* @note On exception, the returned buffer handle is an unknown value and must not be used. (See {@link IAVBuffer} for exception handling behavior).
182189
*
183190
* @pre A pool handle must have been obtained from `createVideoPool()` or `createAudioPool()`.
184191
*

‎avclock/current/com/rdk/hal/avclock/IAVClock.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ import com.rdk.hal.State;
3030
* @author Luc Kennedy-Lamb
3131
* @author Peter Stieglitz
3232
* @author Douglas Adler
33+
*
34+
* <h3>Exception Handling</h3>
35+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
36+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
37+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
38+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
39+
* The caller must ignore any output variables.
3340
*/
3441

3542
@VintfStability

‎avclock/current/com/rdk/hal/avclock/IAVClockController.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ import com.rdk.hal.avclock.ClockTime;
2727
* @author Luc Kennedy-Lamb
2828
* @author Peter Stieglitz
2929
* @author Douglas Adler
30+
*
31+
* <h3>Exception Handling</h3>
32+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
33+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
34+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
35+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
36+
* The caller must ignore any output variables.
3037
*/
3138

3239
@VintfStability

‎avclock/current/com/rdk/hal/avclock/IAVClockManager.aidl‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ import com.rdk.hal.avclock.IAVClock;
2424
* @author Luc Kennedy-Lamb
2525
* @author Peter Stieglitz
2626
* @author Douglas Adler
27+
*
28+
* <h3>Exception Handling</h3>
29+
* Unless otherwise specified, this interface follows standard Android Binder semantics:
30+
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
31+
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
32+
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
33+
* The caller must ignore any output variables.
2734
*/
2835

2936
@VintfStability

0 commit comments

Comments
 (0)