| <!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.5.0_22) on Tue Sep 18 20:44:15 GMT+01:00 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| SessionInputBuffer (HttpComponents Core 4.2.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.http.nio.reactor.SessionInputBuffer interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SessionInputBuffer (HttpComponents Core 4.2.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/SessionInputBuffer.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/http/nio/reactor/SessionBufferStatus.html" title="interface in org.apache.http.nio.reactor"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/http/nio/reactor/SessionOutputBuffer.html" title="interface in org.apache.http.nio.reactor"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/http/nio/reactor/SessionInputBuffer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SessionInputBuffer.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.http.nio.reactor</FONT> |
| <BR> |
| Interface SessionInputBuffer</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/http/impl/nio/reactor/SessionInputBufferImpl.html" title="class in org.apache.http.impl.nio.reactor">SessionInputBufferImpl</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>SessionInputBuffer</B></DL> |
| </PRE> |
| |
| <P> |
| Session input buffer for non-blocking connections. This interface facilitates |
| intermediate buffering of input data streamed from a source channel and |
| reading buffered data to a destination, usually <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio"><CODE>ByteBuffer</CODE></A> or |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels"><CODE>WritableByteChannel</CODE></A>. This interface also provides methods for reading |
| lines of text. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>4.0</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> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#fill(java.nio.channels.ReadableByteChannel)">fill</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels">ReadableByteChannel</A> src)</CODE> |
| |
| <BR> |
| Makes an attempt to fill the buffer with data from the given |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels"><CODE>ReadableByteChannel</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/http/nio/reactor/SessionInputBuffer.html#hasData()">hasData</A></B>()</CODE> |
| |
| <BR> |
| Determines if the buffer contains data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#length()">length</A></B>()</CODE> |
| |
| <BR> |
| Returns the length of this buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#read()">read</A></B>()</CODE> |
| |
| <BR> |
| Reads one byte from the buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#read(java.nio.ByteBuffer)">read</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio">ByteBuffer</A> dst)</CODE> |
| |
| <BR> |
| Reads a sequence of bytes from this buffer into the destination buffer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#read(java.nio.ByteBuffer, int)">read</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio">ByteBuffer</A> dst, |
| int maxLen)</CODE> |
| |
| <BR> |
| Reads a sequence of bytes from this buffer into the destination buffer, |
| up to the given maximum limit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#read(java.nio.channels.WritableByteChannel)">read</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels">WritableByteChannel</A> dst)</CODE> |
| |
| <BR> |
| Reads a sequence of bytes from this buffer into the destination channel.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#read(java.nio.channels.WritableByteChannel, int)">read</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels">WritableByteChannel</A> dst, |
| int maxLen)</CODE> |
| |
| <BR> |
| Reads a sequence of bytes from this buffer into the destination channel, |
| up to the given maximum limit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/http/nio/reactor/SessionInputBuffer.html#readLine(boolean)">readLine</A></B>(boolean endOfStream)</CODE> |
| |
| <BR> |
| Attempts to transfer a complete line of characters up to a line delimiter |
| from this buffer to a newly created string.</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/http/nio/reactor/SessionInputBuffer.html#readLine(org.apache.http.util.CharArrayBuffer, boolean)">readLine</A></B>(<A HREF="../../../../../org/apache/http/util/CharArrayBuffer.html" title="class in org.apache.http.util">CharArrayBuffer</A> dst, |
| boolean endOfStream)</CODE> |
| |
| <BR> |
| Attempts to transfer a complete line of characters up to a line delimiter |
| from this buffer to the destination buffer.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="hasData()"><!-- --></A><H3> |
| hasData</H3> |
| <PRE> |
| boolean <B>hasData</B>()</PRE> |
| <DL> |
| <DD>Determines if the buffer contains data. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if there is data in the buffer, |
| <code>false</code> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="length()"><!-- --></A><H3> |
| length</H3> |
| <PRE> |
| int <B>length</B>()</PRE> |
| <DL> |
| <DD>Returns the length of this buffer. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>buffer length.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="fill(java.nio.channels.ReadableByteChannel)"><!-- --></A><H3> |
| fill</H3> |
| <PRE> |
| int <B>fill</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels">ReadableByteChannel</A> src) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Makes an attempt to fill the buffer with data from the given |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels"><CODE>ReadableByteChannel</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>src</CODE> - the source channel |
| <DT><B>Returns:</B><DD>The number of bytes read, possibly zero, or <tt>-1</tt> if the |
| channel has reached end-of-stream. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - in case of an I/O error.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read()"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| int <B>read</B>()</PRE> |
| <DL> |
| <DD>Reads one byte from the buffer. If the buffer is empty this method can |
| throw a runtime exception. The exact type of runtime exception thrown |
| by this method depends on implementation. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>one byte</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(java.nio.ByteBuffer, int)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| int <B>read</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio">ByteBuffer</A> dst, |
| int maxLen)</PRE> |
| <DL> |
| <DD>Reads a sequence of bytes from this buffer into the destination buffer, |
| up to the given maximum limit. The exact number of bytes transferred |
| depends on availability of data in this buffer and capacity of the |
| destination buffer, but cannot be more than <code>maxLen</code> value. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dst</CODE> - the destination buffer.<DD><CODE>maxLen</CODE> - the maximum number of bytes to be read. |
| <DT><B>Returns:</B><DD>The number of bytes read, possibly zero.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(java.nio.ByteBuffer)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| int <B>read</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html" title="class or interface in java.nio">ByteBuffer</A> dst)</PRE> |
| <DL> |
| <DD>Reads a sequence of bytes from this buffer into the destination buffer. |
| The exact number of bytes transferred depends on availability of data |
| in this buffer and capacity of the destination buffer. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dst</CODE> - the destination buffer. |
| <DT><B>Returns:</B><DD>The number of bytes read, possibly zero.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(java.nio.channels.WritableByteChannel, int)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| int <B>read</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels">WritableByteChannel</A> dst, |
| int maxLen) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Reads a sequence of bytes from this buffer into the destination channel, |
| up to the given maximum limit. The exact number of bytes transferred |
| depends on availability of data in this buffer, but cannot be more than |
| <code>maxLen</code> value. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dst</CODE> - the destination channel.<DD><CODE>maxLen</CODE> - the maximum number of bytes to be read. |
| <DT><B>Returns:</B><DD>The number of bytes read, possibly zero. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - in case of an I/O error.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="read(java.nio.channels.WritableByteChannel)"><!-- --></A><H3> |
| read</H3> |
| <PRE> |
| int <B>read</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels">WritableByteChannel</A> dst) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Reads a sequence of bytes from this buffer into the destination channel. |
| The exact number of bytes transferred depends on availability of data in |
| this buffer. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dst</CODE> - the destination channel. |
| <DT><B>Returns:</B><DD>The number of bytes read, possibly zero. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - in case of an I/O error.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readLine(org.apache.http.util.CharArrayBuffer, boolean)"><!-- --></A><H3> |
| readLine</H3> |
| <PRE> |
| boolean <B>readLine</B>(<A HREF="../../../../../org/apache/http/util/CharArrayBuffer.html" title="class in org.apache.http.util">CharArrayBuffer</A> dst, |
| boolean endOfStream) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/charset/CharacterCodingException.html" title="class or interface in java.nio.charset">CharacterCodingException</A></PRE> |
| <DL> |
| <DD>Attempts to transfer a complete line of characters up to a line delimiter |
| from this buffer to the destination buffer. If a complete line is |
| available in the buffer, the sequence of chars is transferred to the |
| destination buffer the method returns <code>true</code>. The line |
| delimiter itself is discarded. If a complete line is not available in |
| the buffer, this method returns <code>false</code> without transferring |
| anything to the destination buffer. If <code>endOfStream</code> parameter |
| is set to <code>true</code> this method assumes the end of stream has |
| been reached and the content currently stored in the buffer should be |
| treated as a complete line. |
| <p> |
| The choice of a char encoding and line delimiter sequence is up to the |
| specific implementations of this interface. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dst</CODE> - the destination buffer.<DD><CODE>endOfStream</CODE> - |
| <DT><B>Returns:</B><DD><code>true</code> if a sequence of chars representing a complete |
| line has been transferred to the destination buffer, <code>false</code> |
| otherwise. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/charset/CharacterCodingException.html" title="class or interface in java.nio.charset">CharacterCodingException</A></CODE> - in case a character encoding or decoding |
| error occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readLine(boolean)"><!-- --></A><H3> |
| readLine</H3> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>readLine</B>(boolean endOfStream) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/charset/CharacterCodingException.html" title="class or interface in java.nio.charset">CharacterCodingException</A></PRE> |
| <DL> |
| <DD>Attempts to transfer a complete line of characters up to a line delimiter |
| from this buffer to a newly created string. If a complete line is |
| available in the buffer, the sequence of chars is transferred to a newly |
| created string. The line delimiter itself is discarded. If a complete |
| line is not available in the buffer, this method returns |
| <code>null</code>. If <code>endOfStream</code> parameter |
| is set to <code>true</code> this method assumes the end of stream has |
| been reached and the content currently stored in the buffer should be |
| treated as a complete line. |
| <p> |
| The choice of a char encoding and line delimiter sequence is up to the |
| specific implementations of this interface. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>endOfStream</CODE> - |
| <DT><B>Returns:</B><DD>a string representing a complete line, if available. |
| <code>null</code> otherwise. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/charset/CharacterCodingException.html" title="class or interface in java.nio.charset">CharacterCodingException</A></CODE> - in case a character encoding or decoding |
| error occurs.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" 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_bottom_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/SessionInputBuffer.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/http/nio/reactor/SessionBufferStatus.html" title="interface in org.apache.http.nio.reactor"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/http/nio/reactor/SessionOutputBuffer.html" title="interface in org.apache.http.nio.reactor"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/http/nio/reactor/SessionInputBuffer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SessionInputBuffer.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_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
