org.apache.mina.core.write

Class DefaultWriteRequest

java.lang.Object

org.apache.mina.core.write.DefaultWriteRequest

All Implemented Interfaces:

WriteRequest

Direct Known Subclasses:

ProtocolCodecFilter.EncodedWriteRequest

public class DefaultWriteRequest
extends java.lang.Object
implements WriteRequest

The default implementation of WriteRequest.

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.SocketAddress	destination
static byte[]	EMPTY_MESSAGE An empty message
private WriteFuture	future
private java.lang.Object	message
private static WriteFuture	UNUSED_FUTURE An empty FUTURE

Constructor Summary

Constructors

Constructor and Description
DefaultWriteRequest(java.lang.Object message) Creates a new instance without WriteFuture.
DefaultWriteRequest(java.lang.Object message, WriteFuture future) Creates a new instance with WriteFuture.
DefaultWriteRequest(java.lang.Object message, WriteFuture future, java.net.SocketAddress destination) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.net.SocketAddress	getDestination() Returns the destination of this write request.
WriteFuture	getFuture() Returns WriteFuture that is associated with this write request.
java.lang.Object	getMessage() Returns a message object to be written.
WriteRequest	getOriginalRequest() Returns the WriteRequest which was requested originally, which is not transformed by any IoFilter.
boolean	isEncoded() Tells if the current message has been encoded
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_MESSAGE

public static final byte[] EMPTY_MESSAGE

An empty message

UNUSED_FUTURE

private static final WriteFuture UNUSED_FUTURE

An empty FUTURE

message

private final java.lang.Object message

future

private final WriteFuture future

destination

private final java.net.SocketAddress destination

Constructor Detail

DefaultWriteRequest

public DefaultWriteRequest(java.lang.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.

DefaultWriteRequest

public DefaultWriteRequest(java.lang.Object message,
                           WriteFuture future)

Creates a new instance with WriteFuture.

DefaultWriteRequest

public DefaultWriteRequest(java.lang.Object message,
                           WriteFuture future,
                           java.net.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 Detail

getFuture

public WriteFuture getFuture()

Description copied from interface: WriteRequest

Returns WriteFuture that is associated with this write request.

Specified by:

getFuture in interface WriteRequest

getMessage

public java.lang.Object getMessage()

Description copied from interface: WriteRequest

Returns a message object to be written.

Specified by:

getMessage in interface WriteRequest

getOriginalRequest

public WriteRequest getOriginalRequest()

Description copied from interface: WriteRequest

Returns the WriteRequest which was requested originally, which is not transformed by any IoFilter.

Specified by:

getOriginalRequest in interface WriteRequest

getDestination

public java.net.SocketAddress getDestination()

Description copied from interface: WriteRequest

Returns the destination of this write request.

Specified by:

getDestination in interface WriteRequest

Returns:

null for the default destination

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEncoded

public boolean isEncoded()

Description copied from interface: WriteRequest

Tells if the current message has been encoded

Specified by:

isEncoded in interface WriteRequest

Returns:

true if the message has already been encoded