AbstractProtocolEncoderOutput

java.lang.Object

org.apache.mina.filter.codec.AbstractProtocolEncoderOutput

All Implemented Interfaces:: ProtocolEncoderOutput

Direct Known Subclasses:: ProtocolCodecFilter.ProtocolEncoderOutputImpl

public abstract class AbstractProtocolEncoderOutput extends Object implements ProtocolEncoderOutput

A ProtocolEncoderOutput based on queue.

Field Summary

Fields

Modifier and Type

Field

Description

private boolean

buffersOnly

private final Queue<Object>

messageQueue

The queue where the decoded messages are stored
Constructor Summary

Constructors

Constructor

Description

AbstractProtocolEncoderOutput()

Creates an instance of AbstractProtocolEncoderOutput
Method Summary

Modifier and Type

Method

Description

Queue<Object>

getMessageQueue()

void

mergeAll()

Merges all buffers you wrote via ProtocolEncoderOutput.write(Object) into one IoBuffer and replaces the old fragmented ones with it.

void

write(Object encodedMessage)

Callback for ProtocolEncoder to generate an encoded message such as an IoBuffer.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ProtocolEncoderOutput
flush

Field Details
- messageQueue
  
  private final Queue<Object> messageQueue
  
  The queue where the decoded messages are stored
- buffersOnly
  
  private boolean buffersOnly
Constructor Details
- AbstractProtocolEncoderOutput
  
  public AbstractProtocolEncoderOutput()
  
  Creates an instance of AbstractProtocolEncoderOutput
Method Details
- getMessageQueue
  
  public Queue<Object> getMessageQueue()
  
  Returns:
  
  The message queue
- write
  
  public void write(Object encodedMessage)
  
  Callback for ProtocolEncoder to generate an encoded message such as an IoBuffer. ProtocolEncoder must call ProtocolEncoderOutput.write(Object) for each encoded message.
  
  Specified by:
  
  write in interface ProtocolEncoderOutput
  
  Parameters:
  
  encodedMessage - the encoded message, typically an IoBuffer or a FileRegion.
- mergeAll
  
  public void mergeAll()
  
  Merges all buffers you wrote via ProtocolEncoderOutput.write(Object) into one IoBuffer and replaces the old fragmented ones with it. This method is useful when you want to control the way MINA generates network packets. Please note that this method only works when you called ProtocolEncoderOutput.write(Object) method with only IoBuffers.
  
  Specified by:
  
  mergeAll in interface ProtocolEncoderOutput