001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.core.write;
021
022import java.net.SocketAddress;
023
024import org.apache.mina.core.filterchain.IoFilter;
025import org.apache.mina.core.future.WriteFuture;
026import org.apache.mina.core.session.IoSession;
027
028/**
029 * Represents write request fired by {@link IoSession#write(Object)}.
030 *
031 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
032 */
033public interface WriteRequest {
034    /**
035     * @return the {@link WriteRequest} which was requested originally,
036     * which is not transformed by any {@link IoFilter}.
037     */
038    WriteRequest getOriginalRequest();
039
040    /**
041     * @return {@link WriteFuture} that is associated with this write request.
042     */
043    WriteFuture getFuture();
044
045    /**
046     * @return a message object to be written.
047     */
048    Object getMessage();
049
050    /**
051     * Returns the destination of this write request.
052     *
053     * @return <tt>null</tt> for the default destination
054     */
055    SocketAddress getDestination();
056
057    /**
058     * Tells if the current message has been encoded
059     *
060     * @return true if the message has already been encoded
061     */
062    boolean isEncoded();
063}