Package org.apache.http.impl.nio.codecs
Class AbstractContentEncoder
java.lang.Object
org.apache.http.impl.nio.codecs.AbstractContentEncoder
- All Implemented Interfaces:
ContentEncoder
- Direct Known Subclasses:
ChunkEncoder
,IdentityEncoder
,LengthDelimitedEncoder
Abstract
ContentEncoder
that serves as a base for all content
encoder implementations.- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final SessionOutputBuffer
protected final WritableByteChannel
protected boolean
TODO: make privateprotected final HttpTransportMetricsImpl
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractContentEncoder
(WritableByteChannel channel, SessionOutputBuffer buffer, HttpTransportMetricsImpl metrics) Creates an instance of this class. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
complete()
Terminates the content stream.private int
doWriteChunk
(ByteBuffer src, boolean direct) private int
doWriteChunk
(ByteBuffer src, int chunk, boolean direct) protected int
Flushes content of the session buffer to the channel and updates transport metrics.boolean
Returnstrue
if the entity has been transferred in its entirety.protected int
writeToBuffer
(ByteBuffer src, int limit) Transfers content of the source to the buffer and updates transport metrics.protected int
writeToChannel
(ByteBuffer src) Flushes content of the given buffer to the channel and updates transport metrics.protected int
writeToChannel
(ByteBuffer src, int limit) Transfers content of the source to the channel and updates transport metrics.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.http.nio.ContentEncoder
write
-
Field Details
-
channel
-
buffer
-
metrics
-
completed
protected boolean completedTODO: make private
-
-
Constructor Details
-
AbstractContentEncoder
public AbstractContentEncoder(WritableByteChannel channel, SessionOutputBuffer buffer, HttpTransportMetricsImpl metrics) Creates an instance of this class.- Parameters:
channel
- the destination channel.buffer
- the session output buffer that can be used to store session data for intermediate processing.metrics
- Transport metrics of the underlying HTTP transport.
-
-
Method Details
-
isCompleted
public boolean isCompleted()Description copied from interface:ContentEncoder
Returnstrue
if the entity has been transferred in its entirety.- Specified by:
isCompleted
in interfaceContentEncoder
- Returns:
true
if all the content has been produced,false
otherwise.
-
complete
Description copied from interface:ContentEncoder
Terminates the content stream.- Specified by:
complete
in interfaceContentEncoder
- Throws:
IOException
- if I/O error occurs while writing content
-
assertNotCompleted
protected void assertNotCompleted() -
flushToChannel
Flushes content of the session buffer to the channel and updates transport metrics.- Returns:
- number of bytes written to the channel.
- Throws:
IOException
- Since:
- 4.3
-
writeToChannel
Flushes content of the given buffer to the channel and updates transport metrics.- Returns:
- number of bytes written to the channel.
- Throws:
IOException
- Since:
- 4.3
-
writeToChannel
Transfers content of the source to the channel and updates transport metrics.- Parameters:
src
- source.limit
- max number of bytes to transfer.- Returns:
- number of bytes transferred.
- Throws:
IOException
- Since:
- 4.3
-
writeToBuffer
Transfers content of the source to the buffer and updates transport metrics.- Parameters:
src
- source.limit
- max number of bytes to transfer.- Returns:
- number of bytes transferred.
- Throws:
IOException
- Since:
- 4.3
-
doWriteChunk
- Throws:
IOException
-
doWriteChunk
- Throws:
IOException
-