depends.org.apache.http.nio.util

类 SharedOutputBuffer

java.lang.Object

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

depends.org.apache.http.nio.util.SharedOutputBuffer

所有已实现的接口:

BufferInfo, ContentOutputBuffer

@ThreadSafe
public class SharedOutputBuffer
extends ExpandableBuffer
implements ContentOutputBuffer

Implementation of the ContentOutputBuffer 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 expected to transfer data from the buffer to ContentEncoder by calling produceContent(ContentEncoder).

The worker thread is expected to write data to the buffer by calling write(int), write(byte[], int, int) or writeCompleted()

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
int	available() Returns available capacity of this buffer.
int	capacity() Returns the total capacity of this buffer.
void	close()
void	flush()
boolean	hasData() Determines if the buffer contains data.
int	length() Returns the length of this buffer.
int	produceContent(ContentEncoder encoder) 已过时。 (4.3) use produceContent(ContentEncoder, IOControl)
int	produceContent(ContentEncoder encoder, IOControl ioctrl)
void	reset() Resets the buffer by clearing its state and stored content.
void	shutdown()
void	write(byte[] b)
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this buffer.
void	write(int b) Writes the specified byte to this buffer.
void	writeCompleted() Indicates the content has been fully written.

从类继承的方法 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

构造器详细资料

SharedOutputBuffer

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

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

SharedOutputBuffer

public SharedOutputBuffer(int buffersize,
                  ByteBufferAllocator allocator)

从以下版本开始:

4.3

SharedOutputBuffer

public SharedOutputBuffer(int buffersize)

从以下版本开始:

4.3

方法详细资料

reset

public void reset()

从接口复制的说明: ContentOutputBuffer

Resets the buffer by clearing its state and stored content.

指定者:

reset 在接口中 ContentOutputBuffer

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.

produceContent

@Deprecated
public int produceContent(ContentEncoder encoder)
                   throws java.io.IOException

已过时。 (4.3) use produceContent(ContentEncoder, IOControl)

从接口复制的说明: ContentOutputBuffer

Writes content from this buffer to the given ContentEncoder.

指定者:

produceContent 在接口中 ContentOutputBuffer

参数:

encoder - content encoder.

返回:

number of bytes written.

抛出:

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

produceContent

public int produceContent(ContentEncoder encoder,
                 IOControl ioctrl)
                   throws java.io.IOException

抛出:

java.io.IOException

从以下版本开始:

4.3

close

public void close()

shutdown

public void shutdown()

write

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

从接口复制的说明: ContentOutputBuffer

Writes len bytes from the specified byte array starting at offset off to this 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.

指定者:

write 在接口中 ContentOutputBuffer

参数:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

抛出:

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

write

public void write(byte[] b)
           throws java.io.IOException

抛出:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

从接口复制的说明: ContentOutputBuffer

Writes the specified byte to this buffer.

指定者:

write 在接口中 ContentOutputBuffer

参数:

b - the byte.

抛出:

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

flush

public void flush()
           throws java.io.IOException

指定者:

flush 在接口中 ContentOutputBuffer

抛出:

java.io.IOException

writeCompleted

public void writeCompleted()
                    throws java.io.IOException

从接口复制的说明: ContentOutputBuffer

Indicates the content has been fully written.

指定者:

writeCompleted 在接口中 ContentOutputBuffer

抛出:

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