Package org.apache.mina.core.write
Class DefaultWriteRequest
- java.lang.Object
-
- org.apache.mina.core.write.DefaultWriteRequest
-
- All Implemented Interfaces:
WriteRequest
public class DefaultWriteRequest extends java.lang.Object implements WriteRequest
The default implementation ofWriteRequest
.- Author:
- Apache MINA Project
-
-
Field Summary
Fields Modifier and Type Field Description static byte[]
EMPTY_MESSAGE
An empty message
-
Constructor Summary
Constructors Constructor Description DefaultWriteRequest(java.lang.Object message)
Creates a new instance withoutWriteFuture
.DefaultWriteRequest(java.lang.Object message, WriteFuture future)
Creates a new instance withWriteFuture
.DefaultWriteRequest(java.lang.Object message, WriteFuture future, java.net.SocketAddress destination)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.net.SocketAddress
getDestination()
Returns the destination of this write request.WriteFuture
getFuture()
java.lang.Object
getMessage()
java.lang.Object
getOriginalMessage()
WriteRequest
getOriginalRequest()
boolean
isEncoded()
Tells if the current message has been encodedvoid
setMessage(java.lang.Object modifiedMessage)
Set the modified message after it has been processed by a filter.java.lang.String
toString()
-
-
-
Constructor Detail
-
DefaultWriteRequest
public DefaultWriteRequest(java.lang.Object message)
Creates a new instance withoutWriteFuture
. You'll get an instance ofWriteFuture
even if you called this constructor becausegetFuture()
will return a bogus future.- Parameters:
message
- The message that will be written
-
DefaultWriteRequest
public DefaultWriteRequest(java.lang.Object message, WriteFuture future)
Creates a new instance withWriteFuture
.- Parameters:
message
- The message that will be writtenfuture
- The associatedWriteFuture
-
DefaultWriteRequest
public DefaultWriteRequest(java.lang.Object message, WriteFuture future, java.net.SocketAddress destination)
Creates a new instance.- Parameters:
message
- a message to writefuture
- a future that needs to be notified when an operation is finisheddestination
- the destination of the message. This property will be ignored unless the transport supports it.
-
-
Method Detail
-
getFuture
public WriteFuture getFuture()
- Specified by:
getFuture
in interfaceWriteRequest
- Returns:
WriteFuture
that is associated with this write request.
-
getMessage
public java.lang.Object getMessage()
- Specified by:
getMessage
in interfaceWriteRequest
- Returns:
- a message object to be written.
-
setMessage
public void setMessage(java.lang.Object modifiedMessage)
Set the modified message after it has been processed by a filter.- Specified by:
setMessage
in interfaceWriteRequest
- Parameters:
modifiedMessage
- The modified message
-
getOriginalMessage
public java.lang.Object getOriginalMessage()
- Specified by:
getOriginalMessage
in interfaceWriteRequest
- Returns:
- the original message which was sent to the session, before any filter transformation.
-
getOriginalRequest
public WriteRequest getOriginalRequest()
- Specified by:
getOriginalRequest
in interfaceWriteRequest
- Returns:
- the
WriteRequest
which was requested originally, which is not transformed by anyIoFilter
.
-
getDestination
public java.net.SocketAddress getDestination()
Returns the destination of this write request.- Specified by:
getDestination
in interfaceWriteRequest
- Returns:
- null for the default destination
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
isEncoded
public boolean isEncoded()
Tells if the current message has been encoded- Specified by:
isEncoded
in interfaceWriteRequest
- Returns:
- true if the message has already been encoded
-
-