Package org.apache.mina.filter.codec
Interface ProtocolEncoderOutput
- All Known Implementing Classes:
SimpleProtocolEncoderOutput
public interface ProtocolEncoderOutput
Callback for
ProtocolEncoder to generate encoded ByteBuffers.
ProtocolEncoder must call write(ByteBuffer) for each encoded
message.-
Method Summary
Modifier and TypeMethodDescriptionflush()Flushes all buffers you wrote viawrite(ByteBuffer)to the session.voidmergeAll()Merges all buffers you wrote viawrite(ByteBuffer)into oneByteBufferand replaces the old fragmented ones with it.voidwrite(ByteBuffer buf) Callback forProtocolEncoderto generate encodedByteBuffers.
-
Method Details
-
write
Callback forProtocolEncoderto generate encodedByteBuffers.ProtocolEncodermust callwrite(ByteBuffer)for each encoded message.- Parameters:
buf- the buffer which contains encoded data
-
mergeAll
void mergeAll()Merges all buffers you wrote viawrite(ByteBuffer)into oneByteBufferand replaces the old fragmented ones with it. This method is useful when you want to control the way MINA generates network packets. -
flush
WriteFuture flush()Flushes all buffers you wrote viawrite(ByteBuffer)to the session. This operation is asynchronous; please wait for the returnedWriteFutureif you want to wait for the buffers flushed.- Returns:
- null if there is nothing to flush at all.
-