Stay organized with collections
Save and categorize content based on your preferences.
CompletionHandler
public
interface
CompletionHandler
| java.nio.channels.CompletionHandler<V, A>
|
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
void
|
completed(V result, A attachment)
Invoked when an operation has completed.
|
abstract
void
|
failed(Throwable exc, A attachment)
Invoked when an operation fails.
|
Public methods
completed
public abstract void completed (V result,
A attachment)
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
public abstract void failed (Throwable exc,
A attachment)
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.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# CompletionHandler\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nCompletionHandler\n=================\n\n\n`\npublic\n\n\ninterface\nCompletionHandler\n`\n\n\n`\n\n\n`\n\n|---------------------------------------------|\n| java.nio.channels.CompletionHandler\\\u003cV, A\\\u003e |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA handler for consuming the result of an asynchronous I/O operation.\n\nThe asynchronous channels defined in this package allow a completion\nhandler to be specified to consume the result of an asynchronous operation.\nThe [completed](/reference/java/nio/channels/CompletionHandler#completed(V,%20A)) method is invoked when the I/O operation\ncompletes successfully. The [failed](/reference/java/nio/channels/CompletionHandler#failed(java.lang.Throwable,%20A)) method is invoked if the\nI/O operations fails. The implementations of these methods should complete\nin a timely manner so as to avoid keeping the invoking thread from dispatching\nto other completion handlers.\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract void` | ` `[completed](/reference/java/nio/channels/CompletionHandler#completed(V,%20A))`(V result, A attachment) ` Invoked when an operation has completed. |\n| ` abstract void` | ` `[failed](/reference/java/nio/channels/CompletionHandler#failed(java.lang.Throwable,%20A))`(`[Throwable](/reference/java/lang/Throwable)` exc, A attachment) ` Invoked when an operation fails. |\n\nPublic methods\n--------------\n\n### completed\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void completed (V result, \n A attachment)\n```\n\nInvoked when an operation has completed.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------|\n| `result` | `V`: The result of the I/O operation. \u003cbr /\u003e |\n| `attachment` | `A`: The object attached to the I/O operation when it was initiated. \u003cbr /\u003e |\n\n### failed\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void failed (Throwable exc, \n A attachment)\n```\n\nInvoked when an operation fails.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------|\n| `exc` | `Throwable`: The exception to indicate why the I/O operation failed \u003cbr /\u003e |\n| `attachment` | `A`: The object attached to the I/O operation when it was initiated. \u003cbr /\u003e |"]]
