| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| |
| <title>IBuffer (Net4j Signalling Platform Documentation)</title> |
| <meta name="date" content=""> |
| <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="IBuffer (Net4j Signalling Platform Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IBuffer.html">Use</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/eclipse/net4j/buffer/BufferState.html" title="enum in org.eclipse.net4j.buffer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/net4j/buffer/IBufferHandler.html" title="interface in org.eclipse.net4j.buffer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/net4j/buffer/IBuffer.html" target="_top">Frames</a></li> |
| <li><a href="IBuffer.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.eclipse.net4j.buffer</div> |
| <h2 title="Interface IBuffer" class="title">Interface IBuffer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/eclipse/spi/net4j/InternalBuffer.html" title="interface in org.eclipse.spi.net4j">InternalBuffer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IBuffer</span></pre> |
| <div class="block">Basic <b>unit of transport</b> in Net4j. |
| <p> |
| A buffer is well prepared for the usage with asynchronous <a href="../../../../org/eclipse/net4j/channel/IChannel.html" title="interface in org.eclipse.net4j.channel"><code>IChannel</code></a>s but can also be used with pure |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>s. All methods of <code>IBuffer</code> are non-blocking. |
| <p> |
| Usually buffers are obtained from a <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a>. Buffers can be accessed, passed around and finally |
| <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#release--"><code>released</code></a> to their original provider. The capacity of a buffer is determined by its provider. |
| <p> |
| In addition to its payload data each buffer contains an internal header of four bytes, two of them representing a |
| channel identifier the other two of them denoting the length of the payload data. The payload data may be accessed |
| through a <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getByteBuffer--"><code>ByteBuffer</code></a>. |
| <p> |
| This interface is <b>not</b> intended to be implemented by clients. |
| <p> |
| <dt><b>Class Diagram:</b></dt> |
| <dd><img src="doc-files/IBuffer-1.gif" title="Diagram Buffers" border="0" usemap="#IBuffer-1.gif"/></dd> |
| <p> |
| <MAP NAME="IBuffer-1.gif"> <AREA SHAPE="RECT" COORDS="303,12,403,72" HREF="IBufferHandler.html"> <AREA SHAPE="RECT" |
| COORDS="533,199,619,249" HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/nio/ByteBuffer.html"> <AREA SHAPE="RECT" |
| COORDS="283,126,422,322" HREF="IBuffer.html"> <AREA SHAPE="RECT" COORDS="9,180,155,268" HREF="IBufferProvider.html"> |
| <AREA SHAPE="RECT" COORDS="33,321,132,399" HREF="IBufferPool.html"></MAP> |
| <p> |
| <dt><b>State Machine Diagram:</b></dt> |
| <dd><img src="doc-files/BufferState-1.gif" title="Diagram Buffer States" border="0" usemap="#BufferState-1.gif"/></dd> |
| <p> |
| <MAP NAME="BufferState-1.gif"> <AREA SHAPE="RECT" COORDS="300,8,449,34" HREF="BufferState.html#INITIAL"> <AREA |
| SHAPE="RECT" COORDS="46,115,195,139" HREF="BufferState.html#PUTTING"> <AREA SHAPE="RECT" COORDS="48,271,195,295" |
| HREF="BufferState.html#WRITING"> <AREA SHAPE="RECT" COORDS="533,112,681,140" HREF="BufferState.html#READING_HEADER"> |
| <AREA SHAPE="RECT" COORDS="533,271,680,295" HREF="BufferState.html#READING_BODY"> <AREA SHAPE="RECT" |
| COORDS="532,428,682,451" HREF="BufferState.html#GETTING"> </MAP> |
| <p> |
| An example for <b>putting</b> values into a buffer and writing it to a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>: |
| <p> |
| |
| <pre style="background-color:#ffffc8; border-width:1px; border-style:solid; padding:.5em;"> |
| // Obtain a fresh buffer |
| Buffer buffer = bufferProvider.getBuffer(); // Start filling the buffer for channelID 4711 ByteBuffer byteBuffer = |
| buffer.startPutting(4711); byteBuffer.putDouble(15.47); // Write the contents of the Buffer to a // SocketChannel |
| without blocking while (!buffer.write(socketChannel)) { // Do something else } |
| </pre> |
| |
| An example for reading a buffer from a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a> and <b>getting</b> values from it: |
| <p> |
| |
| <pre style="background-color:#ffffc8; border-width:1px; border-style:solid; padding:.5em;"> |
| // Obtain a fresh buffer |
| Buffer buffer = bufferProvider.getBuffer(); |
| |
| // Read the contents of the Buffer from a SocketChannel without blocking |
| ByteBuffer byteBuffer; |
| while ((byteBuffer = buffer.startGetting(socketChannel)) == null) |
| { |
| // Do something else |
| } |
| |
| // Access the contents of the buffer and release it to its provider |
| double value = byteBuffer.getDouble(); |
| buffer.release(); |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a>, |
| <a href="../../../../org/eclipse/net4j/channel/IChannel.html#sendBuffer-org.eclipse.net4j.buffer.IBuffer-"><code>IChannel.sendBuffer(IBuffer)</code></a>, |
| <a href="../../../../org/eclipse/net4j/channel/IChannel.html#setReceiveHandler-org.eclipse.net4j.buffer.IBufferHandler-"><code>IChannel.setReceiveHandler(IBufferHandler)</code></a>, |
| <a href="../../../../org/eclipse/net4j/buffer/IBufferHandler.html#handleBuffer-org.eclipse.net4j.buffer.IBuffer-"><code>IBufferHandler.handleBuffer(IBuffer)</code></a></dd> |
| <dt><span class="simpleTagLabel">No Implement</span></dt> |
| <dd>This interface is not intended to be implemented by clients.</dd> |
| <dt><span class="simpleTagLabel">No Extend</span></dt> |
| <dd>This interface is not intended to be extended by clients.</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#HEADER_SIZE">HEADER_SIZE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#MAX_CHANNEL">MAX_CHANNEL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#MIN_CHANNEL">MIN_CHANNEL</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#NO_CHANNEL">NO_CHANNEL</a></span></code> |
| <div class="block">Possible argument value of <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#startPutting-short-"><code>startPutting(short)</code></a> and possible return value of <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getChannelID--"><code>getChannelID()</code></a> that |
| indicates that this buffer is not intended to be passed to a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#clear--">clear</a></span>()</code> |
| <div class="block">Turns the state of this buffer from any state into <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#INITIAL"><code>INITIAL</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#flip--">flip</a></span>()</code> |
| <div class="block">Turns the state of this buffer from <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a> into <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#GETTING"><code>GETTING</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#formatContent-boolean-">formatContent</a></span>(boolean showHeader)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer">IBufferProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getBufferProvider--">getBufferProvider</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a> that has provided this buffer and that this buffer will be returned to when its |
| <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#release--"><code>release()</code></a> method is called.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getByteBuffer--">getByteBuffer</a></span>()</code> |
| <div class="block">Returns the <code>ByteBuffer</code> that can be used for putting or getting data.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getCapacity--">getCapacity</a></span>()</code> |
| <div class="block">Returns the capacity of this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getChannelID--">getChannelID</a></span>()</code> |
| <div class="block">Returns the channel index value stored in the header of this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/IErrorHandler.html?is-external=true" title="class or interface in org.eclipse.net4j.util">IErrorHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getErrorHandler--">getErrorHandler</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/net4j/buffer/BufferState.html" title="enum in org.eclipse.net4j.buffer">BufferState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getState--">getState</a></span>()</code> |
| <div class="block">Returns the internal state of this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#isCCAM--">isCCAM</a></span>()</code> |
| <div class="block">Returns the <em>Close Channel After Me</em> flag.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#isEOS--">isEOS</a></span>()</code> |
| <div class="block">Returns the <em>End Of Stream</em> flag to indicate whether this buffer is the last buffer in a stream (typically a signal) of buffers.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#release--">release</a></span>()</code> |
| <div class="block">Releases this buffer to its original <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#setCCAM-boolean-">setCCAM</a></span>(boolean ccam)</code> |
| <div class="block">Sets the <em>Close Channel After Me</em> flag.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#setEOS-boolean-">setEOS</a></span>(boolean eos)</code> |
| <div class="block">Sets the <em>End Of Stream</em> flag to indicate whether this buffer is the last buffer in a stream (typically a signal) of buffers.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#setErrorHandler-org.eclipse.net4j.util.IErrorHandler-">setErrorHandler</a></span>(<a href="../../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/IErrorHandler.html?is-external=true" title="class or interface in org.eclipse.net4j.util">IErrorHandler</a> errorHandler)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#startGetting-java.nio.channels.SocketChannel-">startGetting</a></span>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels">SocketChannel</a> socketChannel)</code> |
| <div class="block">Tries to read a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> from a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a> that can be used for getting data.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#startPutting-short-">startPutting</a></span>(short channelID)</code> |
| <div class="block">Returns a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> that can be used for putting data.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#write-java.nio.channels.SocketChannel-">write</a></span>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels">SocketChannel</a> socketChannel)</code> |
| <div class="block">Tries to write the data of this buffer to a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NO_CHANNEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_CHANNEL</h4> |
| <pre>static final short NO_CHANNEL</pre> |
| <div class="block">Possible argument value of <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#startPutting-short-"><code>startPutting(short)</code></a> and possible return value of <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getChannelID--"><code>getChannelID()</code></a> that |
| indicates that this buffer is not intended to be passed to a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.net4j.buffer.IBuffer.NO_CHANNEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MIN_CHANNEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MIN_CHANNEL</h4> |
| <pre>static final short MIN_CHANNEL</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.net4j.buffer.IBuffer.MIN_CHANNEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MAX_CHANNEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAX_CHANNEL</h4> |
| <pre>static final short MAX_CHANNEL</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.net4j.buffer.IBuffer.MAX_CHANNEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HEADER_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HEADER_SIZE</h4> |
| <pre>static final short HEADER_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.net4j.buffer.IBuffer.HEADER_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBufferProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferProvider</h4> |
| <pre><a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer">IBufferProvider</a> getBufferProvider()</pre> |
| <div class="block">Returns the <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a> that has provided this buffer and that this buffer will be returned to when its |
| <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#release--"><code>release()</code></a> method is called.</div> |
| </li> |
| </ul> |
| <a name="getChannelID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChannelID</h4> |
| <pre>short getChannelID()</pre> |
| <div class="block">Returns the channel index value stored in the header of this buffer.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCapacity</h4> |
| <pre>short getCapacity()</pre> |
| <div class="block">Returns the capacity of this buffer. |
| <p> |
| The capacity of this buffer is equal to the <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html#getBufferCapacity--"><code>capacity</code></a> of the |
| <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a> that has provided this buffer.</div> |
| </li> |
| </ul> |
| <a name="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre><a href="../../../../org/eclipse/net4j/buffer/BufferState.html" title="enum in org.eclipse.net4j.buffer">BufferState</a> getState()</pre> |
| <div class="block">Returns the internal state of this buffer.</div> |
| </li> |
| </ul> |
| <a name="startGetting-java.nio.channels.SocketChannel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startGetting</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> startGetting(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels">SocketChannel</a> socketChannel) |
| throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a>, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Tries to read a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> from a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a> that can be used for getting data. |
| <p> |
| This method is non-blocking and it can be necessary to repeatedly call it. If it was not possible to read a |
| complete header from the <code>SocketChannel</code> <code>null</code> is returned and the state of this buffer is |
| <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#READING_HEADER"><code>READING_HEADER</code></a>. If it was not possible to read a complete body from the |
| <code>SocketChannel</code> <code>null</code> is returned and the state of this buffer is |
| <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#READING_BODY"><code>READING_BODY</code></a>. |
| <p> |
| If a <code>ByteBuffer</code> is returned it <b>may only</b> be used for getting data. It is left to the |
| responsibility of the caller that only the following methods of that <code>ByteBuffer</code> are used: |
| <ul> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#get--" title="class or interface in java.nio"><code>ByteBuffer.get()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#get-byte:A-" title="class or interface in java.nio"><code>ByteBuffer.get(byte[])</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#get-int-" title="class or interface in java.nio"><code>ByteBuffer.get(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#get-byte:A-int-int-" title="class or interface in java.nio"><code>ByteBuffer.get(byte[], int, int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getChar--" title="class or interface in java.nio"><code>ByteBuffer.getChar()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getChar-int-" title="class or interface in java.nio"><code>ByteBuffer.getChar(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getDouble--" title="class or interface in java.nio"><code>ByteBuffer.getDouble()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getDouble-int-" title="class or interface in java.nio"><code>ByteBuffer.getDouble(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getFloat--" title="class or interface in java.nio"><code>ByteBuffer.getFloat()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getFloat-int-" title="class or interface in java.nio"><code>ByteBuffer.getFloat(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getInt--" title="class or interface in java.nio"><code>ByteBuffer.getInt()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getInt-int-" title="class or interface in java.nio"><code>ByteBuffer.getInt(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getLong--" title="class or interface in java.nio"><code>ByteBuffer.getLong()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getLong-int-" title="class or interface in java.nio"><code>ByteBuffer.getLong(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getShort--" title="class or interface in java.nio"><code>ByteBuffer.getShort()</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#getShort-int-" title="class or interface in java.nio"><code>ByteBuffer.getShort(int)</code></a> |
| <li>all other methods that do not influence <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#position--" title="class or interface in java.nio"><code>Buffer.position()</code></a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#limit--" title="class or interface in java.nio"><code>Buffer.limit()</code></a> and |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#capacity--" title="class or interface in java.nio"><code>Buffer.capacity()</code></a> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>socketChannel</code> - The <code>socketChannel</code> to read the <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> that can be used for getting data if it was possible to completely read the data from |
| the given <code>SocketChannel</code>, <code>null</code> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the state of this buffer is not <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#INITIAL"><code>INITIAL</code></a>, |
| <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#READING_HEADER"><code>READING_HEADER</code></a> or <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#READING_BODY"><code>READING_BODY</code></a>.</dd> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the <code>SocketChannel</code> has been closed or discovers other I/O problems.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startPutting-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startPutting</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> startPutting(short channelID) |
| throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre> |
| <div class="block">Returns a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> that can be used for putting data. |
| <p> |
| Turns the <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#getState--"><code>state</code></a> of this buffer into <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a>. |
| <p> |
| The returned <code>ByteBuffer</code> <b>may only</b> be used for putting data. It is left to the responsibility of |
| the caller that only the following methods of that <code>ByteBuffer</code> are used: |
| <ul> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#put-byte-" title="class or interface in java.nio"><code>ByteBuffer.put(byte)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#put-byte:A-" title="class or interface in java.nio"><code>ByteBuffer.put(byte[])</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#put-java.nio.ByteBuffer-" title="class or interface in java.nio"><code>ByteBuffer.put(ByteBuffer)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#put-int-byte-" title="class or interface in java.nio"><code>ByteBuffer.put(int, byte)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#put-byte:A-int-int-" title="class or interface in java.nio"><code>ByteBuffer.put(byte[], int, int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putChar-char-" title="class or interface in java.nio"><code>ByteBuffer.putChar(char)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putChar-int-char-" title="class or interface in java.nio"><code>ByteBuffer.putChar(int, char)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putDouble-double-" title="class or interface in java.nio"><code>ByteBuffer.putDouble(double)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putDouble-int-double-" title="class or interface in java.nio"><code>ByteBuffer.putDouble(int, double)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putFloat-float-" title="class or interface in java.nio"><code>ByteBuffer.putFloat(float)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putFloat-int-float-" title="class or interface in java.nio"><code>ByteBuffer.putFloat(int, float)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putInt-int-" title="class or interface in java.nio"><code>ByteBuffer.putInt(int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putInt-int-int-" title="class or interface in java.nio"><code>ByteBuffer.putInt(int, int)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putLong-long-" title="class or interface in java.nio"><code>ByteBuffer.putLong(long)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putLong-int-long-" title="class or interface in java.nio"><code>ByteBuffer.putLong(int, long)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putShort-short-" title="class or interface in java.nio"><code>ByteBuffer.putShort(short)</code></a> |
| <li> <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true#putShort-int-short-" title="class or interface in java.nio"><code>ByteBuffer.putShort(int, short)</code></a> |
| <li>all other methods that do not influence <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#position--" title="class or interface in java.nio"><code>Buffer.position()</code></a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#limit--" title="class or interface in java.nio"><code>Buffer.limit()</code></a> and |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/Buffer.html?is-external=true#capacity--" title="class or interface in java.nio"><code>Buffer.capacity()</code></a> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channelID</code> - The index of an <a href="../../../../org/eclipse/net4j/channel/IChannel.html" title="interface in org.eclipse.net4j.channel"><code>IChannel</code></a> that this buffer is intended to be passed to later or <a href="../../../../org/eclipse/net4j/buffer/IBuffer.html#NO_CHANNEL"><code>NO_CHANNEL</code></a> |
| .</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> that can be used for putting data.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the state of this buffer is not <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#INITIAL"><code>INITIAL</code></a> (<a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a> is allowed but meaningless if and only if the given <code>channelID</code> is equal to the |
| existing <code>channelID</code> of this buffer).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-java.nio.channels.SocketChannel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>boolean write(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels">SocketChannel</a> socketChannel) |
| throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a>, |
| <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Tries to write the data of this buffer to a <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/SocketChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SocketChannel</code></a>. |
| <p> |
| This method is non-blocking and it can be necessary to repeatedly call it. If it was not possible to completely |
| write the data to the <code>SocketChannel</code> <code>false</code> is returned and the state of this buffer |
| remains <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#WRITING"><code>WRITING</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>socketChannel</code> - The <code>socketChannel</code> to write the data to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if it was possible to completely write the data to the <code>SocketChannel</code>, |
| <code>false</code> otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the state of this buffer is not <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a> or <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#WRITING"><code>WRITING</code></a>.</dd> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the <code>SocketChannel</code> has been closed or discovers other I/O problems.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flip--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flip</h4> |
| <pre>void flip() |
| throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre> |
| <div class="block">Turns the state of this buffer from <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a> into <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#GETTING"><code>GETTING</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the state of this buffer is not <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByteBuffer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteBuffer</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> getByteBuffer() |
| throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre> |
| <div class="block">Returns the <code>ByteBuffer</code> that can be used for putting or getting data.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the state of this buffer is not <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#PUTTING"><code>PUTTING</code></a> or <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#GETTING"><code>GETTING</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEOS--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEOS</h4> |
| <pre>boolean isEOS()</pre> |
| <div class="block">Returns the <em>End Of Stream</em> flag to indicate whether this buffer is the last buffer in a stream (typically a signal) of buffers.</div> |
| </li> |
| </ul> |
| <a name="setEOS-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEOS</h4> |
| <pre>void setEOS(boolean eos)</pre> |
| <div class="block">Sets the <em>End Of Stream</em> flag to indicate whether this buffer is the last buffer in a stream (typically a signal) of buffers.</div> |
| </li> |
| </ul> |
| <a name="isCCAM--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCCAM</h4> |
| <pre>boolean isCCAM()</pre> |
| <div class="block">Returns the <em>Close Channel After Me</em> flag.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.4</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCCAM-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCCAM</h4> |
| <pre>void setCCAM(boolean ccam)</pre> |
| <div class="block">Sets the <em>Close Channel After Me</em> flag.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.4</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="release--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre>void release()</pre> |
| <div class="block">Releases this buffer to its original <a href="../../../../org/eclipse/net4j/buffer/IBufferProvider.html" title="interface in org.eclipse.net4j.buffer"><code>IBufferProvider</code></a>.</div> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>void clear()</pre> |
| <div class="block">Turns the state of this buffer from any state into <a href="../../../../org/eclipse/net4j/buffer/BufferState.html#INITIAL"><code>INITIAL</code></a>.</div> |
| </li> |
| </ul> |
| <a name="formatContent-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>formatContent</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatContent(boolean showHeader)</pre> |
| </li> |
| </ul> |
| <a name="getErrorHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErrorHandler</h4> |
| <pre><a href="../../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/IErrorHandler.html?is-external=true" title="class or interface in org.eclipse.net4j.util">IErrorHandler</a> getErrorHandler()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setErrorHandler-org.eclipse.net4j.util.IErrorHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setErrorHandler</h4> |
| <pre>void setErrorHandler(<a href="../../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/IErrorHandler.html?is-external=true" title="class or interface in org.eclipse.net4j.util">IErrorHandler</a> errorHandler)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </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/IBuffer.html">Use</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/eclipse/net4j/buffer/BufferState.html" title="enum in org.eclipse.net4j.buffer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/net4j/buffer/IBufferHandler.html" title="interface in org.eclipse.net4j.buffer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/net4j/buffer/IBuffer.html" target="_top">Frames</a></li> |
| <li><a href="IBuffer.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><i>Copyright (c) 2011-2015 Eike Stepper (Berlin, Germany) and others.</i></small></p> |
| </body> |
| </html> |
