📄 writefuture.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.6.0_04) on Tue Feb 19 10:50:43 MST 2008 --><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><TITLE>WriteFuture (Apache MINA 2.0.0-M1 API Documentation)</TITLE><META NAME="date" CONTENT="2008-02-19"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ if (location.href.indexOf('is-external=true') == -1) { parent.document.title="WriteFuture (Apache MINA 2.0.0-M1 API Documentation)"; }}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><HR><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/WriteFuture.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/mina/common/WriteException.html" title="class in org.apache.mina.common"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/mina/common/WriteRequest.html" title="interface in org.apache.mina.common"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/mina/common/WriteFuture.html" target="_top"><B>FRAMES</B></A> <A HREF="WriteFuture.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.apache.mina.common</FONT><BR>Interface WriteFuture</H2><DL><DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/mina/common/IoFuture.html" title="interface in org.apache.mina.common">IoFuture</A></DD></DL><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/mina/common/DefaultWriteFuture.html" title="class in org.apache.mina.common">DefaultWriteFuture</A></DD></DL><HR><DL><DT><PRE>public interface <B>WriteFuture</B><DT>extends <A HREF="../../../../org/apache/mina/common/IoFuture.html" title="interface in org.apache.mina.common">IoFuture</A></DL></PRE><P>An <A HREF="../../../../org/apache/mina/common/IoFuture.html" title="interface in org.apache.mina.common"><CODE>IoFuture</CODE></A> for asynchronous write requests. <h3>Example</h3> <pre> 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) } </pre><P><P><DL><DT><B>Version:</B></DT> <DD>$Rev: 591310 $, $Date: 2007-11-02 05:57:00 -0600 (Fri, 02 Nov 2007) $</DD><DT><B>Author:</B></DT> <DD>The Apache MINA Project (dev@mina.apache.org)</DD></DL><HR><P><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#addListener(org.apache.mina.common.IoFutureListener)">addListener</A></B>(<A HREF="../../../../org/apache/mina/common/IoFutureListener.html" title="interface in org.apache.mina.common">IoFutureListener</A><?> listener)</CODE><BR> Adds an event <tt>listener</tt> which is notified when the state of this future changes.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#await()">await</A></B>()</CODE><BR> Wait for the asynchronous operation to end.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#awaitUninterruptibly()">awaitUninterruptibly</A></B>()</CODE><BR> Wait for the asynchronous operation to end uninterruptibly.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#getException()">getException</A></B>()</CODE><BR> Returns the cause of the write failure if and only if the write operation has failed due to an <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><CODE>Exception</CODE></A>.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#isWritten()">isWritten</A></B>()</CODE><BR> Returns <tt>true</tt> if the write operation is finished successfully.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../org/apache/mina/common/WriteFuture.html" title="interface in org.apache.mina.common">WriteFuture</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#removeListener(org.apache.mina.common.IoFutureListener)">removeListener</A></B>(<A HREF="../../../../org/apache/mina/common/IoFutureListener.html" title="interface in org.apache.mina.common">IoFutureListener</A><?> listener)</CODE><BR> Removes an existing event <tt>listener</tt> which is notified when the state of this future changes.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#setException(java.lang.Throwable)">setException</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A> cause)</CODE><BR> Sets the cause of the write failure, and notifies all threads waiting for this future.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/mina/common/WriteFuture.html#setWritten()">setWritten</A></B>()</CODE><BR> Sets the message is written, and notifies all threads waiting for this future.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.apache.mina.common.IoFuture"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from interface org.apache.mina.common.<A HREF="../../../../org/apache/mina/common/IoFuture.html" title="interface in org.apache.mina.common">IoFuture</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../org/apache/mina/common/IoFuture.html#await(long)">await</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#await(long, java.util.concurrent.TimeUnit)">await</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#awaitUninterruptibly(long)">awaitUninterruptibly</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#awaitUninterruptibly(long, java.util.concurrent.TimeUnit)">awaitUninterruptibly</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#getSession()">getSession</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#isReady()">isReady</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#join()">join</A>, <A HREF="../../../../org/apache/mina/common/IoFuture.html#join(long)">join</A></CODE></TD>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -