depends.org.apache.http.nio.util

类 SharedInputBuffer

java.lang.Object

depends.org.apache.http.nio.util.ExpandableBuffer

depends.org.apache.http.nio.util.SharedInputBuffer

所有已实现的接口:

BufferInfo, ContentInputBuffer

@ThreadSafe
public class SharedInputBuffer
extends ExpandableBuffer
implements ContentInputBuffer

Implementation of the ContentInputBuffer interface that can be shared by multiple threads, usually the I/O dispatch of an I/O reactor and a worker thread.

The I/O dispatch thread is expect to transfer data from ContentDecoder to the buffer by calling consumeContent(ContentDecoder).

The worker thread is expected to read the data from the buffer by calling read() or read(byte[], int, int) methods.

In case of an abnormal situation or when no longer needed the buffer must be shut down using shutdown() method.

从以下版本开始:

4.0

字段概要

从类继承的字段 depends.org.apache.http.nio.util.ExpandableBuffer

buffer, INPUT_MODE, OUTPUT_MODE

构造器概要

构造器

构造器和说明
SharedInputBuffer(int buffersize)
SharedInputBuffer(int buffersize, ByteBufferAllocator allocator)
SharedInputBuffer(int buffersize, IOControl ioctrl, ByteBufferAllocator allocator) 已过时。 (4.3) use SharedInputBuffer(int, ByteBufferAllocator)

方法概要

方法

限定符和类型	方法和说明
int	available() Returns available capacity of this buffer.
int	capacity() Returns the total capacity of this buffer.
void	close()
int	consumeContent(ContentDecoder decoder) 已过时。 (4.3) use consumeContent(ContentDecoder, IOControl)
int	consumeContent(ContentDecoder decoder, IOControl ioctrl)
boolean	hasData() Determines if the buffer contains data.
protected boolean	isEndOfStream()
protected boolean	isShutdown()
int	length() Returns the length of this buffer.
int	read() Reads one byte from this buffer.
int	read(byte[] b)
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this buffer into an array of bytes.
void	reset() Resets the buffer by clearing its state and stored content.
void	shutdown()
protected void	waitForData()

从类继承的方法 depends.org.apache.http.nio.util.ExpandableBuffer

clear, ensureCapacity, expand, getMode, setInputMode, setOutputMode, toString

从类继承的方法 java.lang.Object

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

构造器详细资料

SharedInputBuffer

@Deprecated
public SharedInputBuffer(int buffersize,
                            IOControl ioctrl,
                            ByteBufferAllocator allocator)

已过时。 (4.3) use SharedInputBuffer(int, ByteBufferAllocator)

SharedInputBuffer

public SharedInputBuffer(int buffersize,
                 ByteBufferAllocator allocator)

从以下版本开始:

4.3

SharedInputBuffer

public SharedInputBuffer(int buffersize)

从以下版本开始:

4.3

方法详细资料

reset

public void reset()

从接口复制的说明: ContentInputBuffer

Resets the buffer by clearing its state and stored content.

指定者:

reset 在接口中 ContentInputBuffer

consumeContent

@Deprecated
public int consumeContent(ContentDecoder decoder)
                   throws java.io.IOException

已过时。 (4.3) use consumeContent(ContentDecoder, IOControl)

从接口复制的说明: ContentInputBuffer

Reads content from the given ContentDecoder and stores it in this buffer.

指定者:

consumeContent 在接口中 ContentInputBuffer

参数:

decoder - the content decoder.

返回:

number of bytes read.

抛出:

java.io.IOException - in case of an I/O error.

consumeContent

public int consumeContent(ContentDecoder decoder,
                 IOControl ioctrl)
                   throws java.io.IOException

抛出:

java.io.IOException

从以下版本开始:

4.3

hasData

public boolean hasData()

从类复制的说明: ExpandableBuffer

Determines if the buffer contains data.

覆盖:

hasData 在类中 ExpandableBuffer

返回:

true if there is data in the buffer, false otherwise.

available

public int available()

从类复制的说明: ExpandableBuffer

Returns available capacity of this buffer.

指定者:

available 在接口中 BufferInfo

覆盖:

available 在类中 ExpandableBuffer

返回:

buffer length.

capacity

public int capacity()

从类复制的说明: ExpandableBuffer

Returns the total capacity of this buffer.

指定者:

capacity 在接口中 BufferInfo

覆盖:

capacity 在类中 ExpandableBuffer

返回:

total capacity.

length

public int length()

从类复制的说明: ExpandableBuffer

Returns the length of this buffer.

指定者:

length 在接口中 BufferInfo

覆盖:

length 在类中 ExpandableBuffer

返回:

buffer length.

waitForData

protected void waitForData()
                    throws java.io.IOException

抛出:

java.io.IOException

close

public void close()

shutdown

public void shutdown()

isShutdown

protected boolean isShutdown()

isEndOfStream

protected boolean isEndOfStream()

read

public int read()
         throws java.io.IOException

从接口复制的说明: ContentInputBuffer

Reads one byte from this buffer. If the buffer is empty this method can throw a runtime exception. The exact category of runtime exception thrown by this method depends on implementation. This method returns -1 if the end of content stream has been reached.

指定者:

read 在接口中 ContentInputBuffer

返回:

one byte

抛出:

java.io.IOException

read

public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

从接口复制的说明: ContentInputBuffer

Reads up to len bytes of data from this buffer into an array of bytes. The exact number of bytes read depends how many bytes are stored in the buffer.

If off is negative, or len is negative, or off+len is greater than the length of the array b, this method can throw a runtime exception. The exact category of runtime exception thrown by this method depends on implementation. This method returns -1 if the end of content stream has been reached.

指定者:

read 在接口中 ContentInputBuffer

参数:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes to read.

返回:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

抛出:

java.io.IOException - if an I/O error occurs.

read

public int read(byte[] b)
         throws java.io.IOException

抛出:

java.io.IOException