public interface ReadFuture extends IoFuture
IoFuture
for asynchronous read requests
.
IoSession session = ...; // useReadOperation must be enabled to use read operation. session.getConfig().setUseReadOperation(true); ReadFuture future = session.read(); // Wait until a message is received. future.await(); try { Object message = future.getMessage(); } catch (Exception e) { ... }
Modifier and Type | Method and Description |
---|---|
ReadFuture |
addListener(IoFutureListener<?> listener)
Adds an event listener which is notified when
this future is completed.
|
ReadFuture |
await()
Wait for the asynchronous operation to complete.
|
ReadFuture |
awaitUninterruptibly()
Wait for the asynchronous operation to complete uninterruptibly.
|
java.lang.Throwable |
getException()
Returns the cause of the read failure if and only if the read
operation has failed due to an
Exception . |
java.lang.Object |
getMessage()
Returns the received message.
|
boolean |
isClosed()
Returns true if the
IoSession associated with this
future has been closed. |
boolean |
isRead()
Returns true if a message was received successfully.
|
ReadFuture |
removeListener(IoFutureListener<?> listener)
Removes an existing event listener so it won't be notified when
the future is completed.
|
void |
setClosed()
Sets the associated
IoSession is closed. |
void |
setException(java.lang.Throwable cause)
Sets the cause of the read failure, and notifies all threads waiting
for this future.
|
void |
setRead(java.lang.Object message)
Sets the message is written, and notifies all threads waiting for
this future.
|
await, await, awaitUninterruptibly, awaitUninterruptibly, getSession, isDone, join, join
java.lang.Object getMessage()
IoSession
has been closed.java.lang.RuntimeException
- if read or any relevant operation has failed.boolean isRead()
boolean isClosed()
IoSession
associated with this
future has been closed.java.lang.Throwable getException()
Exception
. Otherwise,
null is returned.void setRead(java.lang.Object message)
void setClosed()
IoSession
is closed. This method is invoked
by MINA internally. Please do not call this method directly.void setException(java.lang.Throwable cause)
ReadFuture await() throws java.lang.InterruptedException
IoFuture
ReadFuture awaitUninterruptibly()
IoFuture
awaitUninterruptibly
in interface IoFuture
ReadFuture addListener(IoFutureListener<?> listener)
IoFuture
addListener
in interface IoFuture
ReadFuture removeListener(IoFutureListener<?> listener)
IoFuture
removeListener
in interface IoFuture
Copyright © 2004-2019 Apache MINA Project. All Rights Reserved.