| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_191) on Fri Mar 15 09:53:54 CET 2019 --> |
| <title>WriteFuture (Apache MINA)</title> |
| <meta name="date" content="2019-03-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WriteFuture (Apache MINA)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":9,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WriteFuture.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/WriteTimeoutException.html" title="class in org.apache.mina.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/common/WriteFuture.html" target="_top">Frames</a></li> |
| <li><a href="WriteFuture.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.mina.common.IoFuture">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mina.common</div> |
| <h2 title="Class WriteFuture" class="title">Class WriteFuture</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/mina/common/IoFuture.html" title="class in org.apache.mina.common">org.apache.mina.common.IoFuture</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.common.WriteFuture</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WriteFuture</span> |
| extends <a href="../../../../org/apache/mina/common/IoFuture.html" title="class in org.apache.mina.common">IoFuture</a></pre> |
| <div class="block">An <a href="../../../../org/apache/mina/common/IoFuture.html" title="class 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></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 354683 $, $Date: 2005-12-07 04:03:15 +0100 (Wed, 07 Dec 2005) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache Directory Project</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.mina.common.IoFuture"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoFuture.html" title="class in org.apache.mina.common">IoFuture</a></h3> |
| <code><a href="../../../../org/apache/mina/common/IoFuture.Callback.html" title="interface in org.apache.mina.common">IoFuture.Callback</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#WriteFuture--">WriteFuture</a></span>()</code> |
| <div class="block">Creates a new instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#WriteFuture-java.lang.Object-">WriteFuture</a></span>(java.lang.Object lock)</code> |
| <div class="block">Creates a new instance which uses the specified object as a lock.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#isWritten--">isWritten</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if the write operation is finished successfully.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common">WriteFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#newNotWrittenFuture--">newNotWrittenFuture</a></span>()</code> |
| <div class="block">Returns a new <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common"><code>WriteFuture</code></a> which is already marked as 'not written'.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common">WriteFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#newWrittenFuture--">newWrittenFuture</a></span>()</code> |
| <div class="block">Returns a new <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common"><code>WriteFuture</code></a> which is already marked as 'written'.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/WriteFuture.html#setWritten-boolean-">setWritten</a></span>(boolean written)</code> |
| <div class="block">This method is invoked by MINA internally.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.IoFuture"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoFuture.html" title="class in org.apache.mina.common">IoFuture</a></h3> |
| <code><a href="../../../../org/apache/mina/common/IoFuture.html#getCallback--">getCallback</a>, <a href="../../../../org/apache/mina/common/IoFuture.html#getLock--">getLock</a>, <a href="../../../../org/apache/mina/common/IoFuture.html#getValue--">getValue</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>, <a href="../../../../org/apache/mina/common/IoFuture.html#setCallback-org.apache.mina.common.IoFuture.Callback-">setCallback</a>, <a href="../../../../org/apache/mina/common/IoFuture.html#setValue-java.lang.Object-">setValue</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WriteFuture--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WriteFuture</h4> |
| <pre>public WriteFuture()</pre> |
| <div class="block">Creates a new instance.</div> |
| </li> |
| </ul> |
| <a name="WriteFuture-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WriteFuture</h4> |
| <pre>public WriteFuture(java.lang.Object lock)</pre> |
| <div class="block">Creates a new instance which uses the specified object as a lock.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newWrittenFuture--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newWrittenFuture</h4> |
| <pre>public static <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common">WriteFuture</a> newWrittenFuture()</pre> |
| <div class="block">Returns a new <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common"><code>WriteFuture</code></a> which is already marked as 'written'.</div> |
| </li> |
| </ul> |
| <a name="newNotWrittenFuture--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newNotWrittenFuture</h4> |
| <pre>public static <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common">WriteFuture</a> newNotWrittenFuture()</pre> |
| <div class="block">Returns a new <a href="../../../../org/apache/mina/common/WriteFuture.html" title="class in org.apache.mina.common"><code>WriteFuture</code></a> which is already marked as 'not written'.</div> |
| </li> |
| </ul> |
| <a name="isWritten--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWritten</h4> |
| <pre>public boolean isWritten()</pre> |
| <div class="block">Returns <tt>true</tt> if the write operation is finished successfully.</div> |
| </li> |
| </ul> |
| <a name="setWritten-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setWritten</h4> |
| <pre>public void setWritten(boolean written)</pre> |
| <div class="block">This method is invoked by MINA internally. Please do not call this method |
| directly.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WriteFuture.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/mina/common/TransportType.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/common/WriteTimeoutException.html" title="class in org.apache.mina.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/common/WriteFuture.html" target="_top">Frames</a></li> |
| <li><a href="WriteFuture.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.mina.common.IoFuture">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
