Stay organized with collections
Save and categorize content based on your preferences.
CompletionHandler
interface CompletionHandler<V : Any!, A : Any!>
A handler for consuming the result of an asynchronous I/O operation.
The asynchronous channels defined in this package allow a completion handler to be specified to consume the result of an asynchronous operation. The completed method is invoked when the I/O operation completes successfully. The failed method is invoked if the I/O operations fails. The implementations of these methods should complete in a timely manner so as to avoid keeping the invoking thread from dispatching to other completion handlers.
Summary
| Public methods |
| abstract Unit |
Invoked when an operation has completed.
|
| abstract Unit |
Invoked when an operation fails.
|
Public methods
completed
abstract fun completed(
result: V,
attachment: A
): Unit
Invoked when an operation has completed.
| Parameters |
result |
V: The result of the I/O operation. |
attachment |
A: The object attached to the I/O operation when it was initiated. |
failed
abstract fun failed(
exc: Throwable!,
attachment: A
): Unit
Invoked when an operation fails.
| Parameters |
exc |
Throwable!: The exception to indicate why the I/O operation failed |
attachment |
A: The object attached to the I/O operation when it was initiated. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# CompletionHandler\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCompletionHandler\n=================\n\n```\ninterface CompletionHandler\u003cV : Any!, A : Any!\u003e\n```\n\n|------------------------------------------|\n| [java.nio.channels.CompletionHandler](#) |\n\nA handler for consuming the result of an asynchronous I/O operation.\n\nThe asynchronous channels defined in this package allow a completion handler to be specified to consume the result of an asynchronous operation. The [completed](#completed(java.nio.channels.CompletionHandler.V,%20java.nio.channels.CompletionHandler.A)) method is invoked when the I/O operation completes successfully. The [failed](#failed(kotlin.Throwable,%20java.nio.channels.CompletionHandler.A)) method is invoked if the I/O operations fails. The implementations of these methods should complete in a timely manner so as to avoid keeping the invoking thread from dispatching to other completion handlers.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [completed](#completed(java.nio.channels.CompletionHandler.V,%20java.nio.channels.CompletionHandler.A))`(`result:` `V`, `attachment:` `A`)` Invoked when an operation has completed. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [failed](#failed(kotlin.Throwable,%20java.nio.channels.CompletionHandler.A))`(`exc:` `[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)!`, `attachment:` `A`)` Invoked when an operation fails. |\n\nPublic methods\n--------------\n\n### completed\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun completed(\n result: V, \n attachment: A\n): Unit\n```\n\nInvoked when an operation has completed.\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------|\n| `result` | V: The result of the I/O operation. |\n| `attachment` | A: The object attached to the I/O operation when it was initiated. |\n\n### failed\n\nAdded in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun failed(\n exc: Throwable!, \n attachment: A\n): Unit\n```\n\nInvoked when an operation fails.\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `exc` | [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)!: The exception to indicate why the I/O operation failed |\n| `attachment` | A: The object attached to the I/O operation when it was initiated. |"]]
