org.apache.river.jeri.internal.mux

Class IOFuture

java.lang.Object

org.apache.river.jeri.internal.mux.IOFuture

final class IOFuture
extends Object

An IOFuture represents an I/O operation that may or may not have completed yet.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	data
private boolean	done
private IOException	exception
private int	position

Constructor Summary

Constructors

Constructor and Description
IOFuture()

Method Summary

Modifier and Type	Method and Description
(package private) void	done() Signals that this I/O operation has completed successfully.
(package private) void	done(int position) Signals that this I/O operation has remaining data.
(package private) void	done(IOException e) Signals that this I/O operation has failed (with details of the failure in the given IOException).
(package private) int	getPosition()
(package private) boolean	waitUntilDone() Waits until the I/O operation has completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

done

private boolean done

data

boolean data

position

private int position

exception

private IOException exception

Constructor Detail

IOFuture

IOFuture()

Method Detail

waitUntilDone

boolean waitUntilDone()
               throws IOException,
                      InterruptedException

Waits until the I/O operation has completed. If this method returns normally, then the I/O operation has completed successfully. If this method throws IOException, then the I/O operation failed. REMIND: Maybe we should support a timeout here, as a paranoid escape hatch; if this wait really takes a long time, something has gone dreadfully wrong. To a large extent, we're really depending on someone's finally clause to make sure that pending instances of this class always get notified somehow.

Returns:

true if data remaining.

Throws:

IOException - if the I/O operation failed

InterruptedException - if the current thread was interrupted while waiting for the I/O to complete.

getPosition

int getPosition()

done

void done()

Signals that this I/O operation has completed successfully.

done

void done(int position)

Signals that this I/O operation has remaining data.

Parameters:

position -

done

void done(IOException e)

Signals that this I/O operation has failed (with details of the failure in the given IOException).

Parameters:

e - detail of the I/O operation's failure