Class DefaultWriteRequest

java.lang.Object
org.apache.mina.core.write.DefaultWriteRequest
All Implemented Interfaces:
WriteRequest
Direct Known Subclasses:
ProtocolCodecFilter.EncodedWriteRequest, SslFilter.EncryptedWriteRequest
public class DefaultWriteRequest extends Object implements WriteRequest
The default implementation of WriteRequest.

  • Field Details

    • EMPTY_MESSAGE

      public static final byte[] EMPTY_MESSAGE
      An empty message

    • UNUSED_FUTURE

      private static final WriteFuture UNUSED_FUTURE
      An empty FUTURE

    • originalMessage

      private final Object originalMessage
      The original message as it was written by the IoHandler. It will be sent back in the messageSent event

    • message

      private Object message
      The message that will ultimately be written to the remote peer

    • future

      private final WriteFuture future
      The associated Future

    • destination

      private final SocketAddress destination
      The peer destination (useless ???)

  • Constructor Details

    • DefaultWriteRequest

      public DefaultWriteRequest(Object message)
      Creates a new instance without WriteFuture. You'll get an instance of WriteFuture even if you called this constructor because getFuture() will return a bogus future.
      Parameters:
      message - The message that will be written

    • DefaultWriteRequest

      public DefaultWriteRequest(Object message, WriteFuture future)
      Creates a new instance with WriteFuture.
      Parameters:
      message - The message that will be written
      future - The associated WriteFuture

    • DefaultWriteRequest

      public DefaultWriteRequest(Object message, WriteFuture future, SocketAddress destination)
      Creates a new instance.
      Parameters:
      message - a message to write
      future - a future that needs to be notified when an operation is finished
      destination - the destination of the message. This property will be ignored unless the transport supports it.

  • Method Details

    • getFuture

      public WriteFuture getFuture()
      Specified by:
      getFuture in interface WriteRequest
      Returns:
      WriteFuture that is associated with this write request.

    • getMessage

      public Object getMessage()
      Specified by:
      getMessage in interface WriteRequest
      Returns:
      a message object to be written.

    • setMessage

      public void setMessage(Object modifiedMessage)
      Set the modified message after it has been processed by a filter.
      Specified by:
      setMessage in interface WriteRequest
      Parameters:
      modifiedMessage - The modified message

    • getOriginalMessage

      public Object getOriginalMessage()
      Specified by:
      getOriginalMessage in interface WriteRequest
      Returns:
      the original message which was sent to the session, before any filter transformation.

    • getOriginalRequest

      public WriteRequest getOriginalRequest()
      Specified by:
      getOriginalRequest in interface WriteRequest
      Returns:
      the WriteRequest which was requested originally, which is not transformed by any IoFilter.

    • getDestination

      public SocketAddress getDestination()
      Returns the destination of this write request.
      Specified by:
      getDestination in interface WriteRequest
      Returns:
      null for the default destination

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isEncoded

      public boolean isEncoded()
      Tells if the current message has been encoded
      Specified by:
      isEncoded in interface WriteRequest
      Returns:
      true if the message has already been encoded