public interface WriteFuture extends IoFuture
IoFuture
for asynchronous write requests.
IoSession session = ...; WriteFuture future = session.write(...); // Wait until the message is completely written out to the O/S buffer. future.join(); if( future.isWritten() ) { // The message has been written successfully. } else { // The messsage couldn't be written out completely for some reason. // (e.g. Connection is closed) }
Modifier and Type | Method and Description |
---|---|
WriteFuture |
addListener(IoFutureListener<?> listener)
Adds an event listener which is notified when
this future is completed.
|
WriteFuture |
await()
Wait for the asynchronous operation to complete.
|
WriteFuture |
awaitUninterruptibly()
Wait for the asynchronous operation to complete uninterruptibly.
|
java.lang.Throwable |
getException()
Returns the cause of the write failure if and only if the write
operation has failed due to an
Exception . |
boolean |
isWritten()
Returns true if the write operation is finished successfully.
|
WriteFuture |
removeListener(IoFutureListener<?> listener)
Removes an existing event listener so it won't be notified when
the future is completed.
|
void |
setException(java.lang.Throwable cause)
Sets the cause of the write failure, and notifies all threads waiting
for this future.
|
void |
setWritten()
Sets the message is written, and notifies all threads waiting for
this future.
|
await, await, awaitUninterruptibly, awaitUninterruptibly, getSession, isDone, join, join
boolean isWritten()
java.lang.Throwable getException()
Exception
. Otherwise,
null is returned.void setWritten()
void setException(java.lang.Throwable cause)
WriteFuture await() throws java.lang.InterruptedException
await
in interface IoFuture
WriteFuture
java.lang.InterruptedException
WriteFuture awaitUninterruptibly()
awaitUninterruptibly
in interface IoFuture
WriteFuture addListener(IoFutureListener<?> listener)
addListener
in interface IoFuture
WriteFuture removeListener(IoFutureListener<?> listener)
removeListener
in interface IoFuture
Copyright © 2004-2019 Apache MINA Project. All Rights Reserved.