View Javadoc

    1   /*
    2    *  Licensed to the Apache Software Foundation (ASF) under one
    3    *  or more contributor license agreements.  See the NOTICE file
    4    *  distributed with this work for additional information
    5    *  regarding copyright ownership.  The ASF licenses this file
    6    *  to you under the Apache License, Version 2.0 (the
    7    *  "License"); you may not use this file except in compliance
    8    *  with the License.  You may obtain a copy of the License at
    9    *
    10   *    http://www.apache.org/licenses/LICENSE-2.0
    11   *
    12   *  Unless required by applicable law or agreed to in writing,
    13   *  software distributed under the License is distributed on an
    14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15   *  KIND, either express or implied.  See the License for the
    16   *  specific language governing permissions and limitations
    17   *  under the License.
    18   *
    19   */
    20  package org.apache.mina.core.write;
    21
    22  import java.net.SocketAddress;
    23
    24  import org.apache.mina.core.filterchain.IoFilter;
    25  import org.apache.mina.core.future.WriteFuture;
    26  import org.apache.mina.core.session.IoSession;
    27
    28  /**
    29   * Represents write request fired by {@link IoSession#write(Object)}.
    30   *
    31   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    32   */
    33  public interface WriteRequest {
    34      /**
    35       * Returns the {@link WriteRequest} which was requested originally,
    36       * which is not transformed by any {@link IoFilter}.
    37       */
    38      WriteRequest getOriginalRequest();
    39
    40      /**
    41       * Returns {@link WriteFuture} that is associated with this write request.
    42       */
    43      WriteFuture getFuture();
    44
    45      /**
    46       * Returns a message object to be written.
    47       */
    48      Object getMessage();
    49
    50      /**
    51       * Returns the destination of this write request.
    52       *
    53       * @return <tt>null</tt> for the default destination
    54       */
    55      SocketAddress getDestination();
    56
    57      /**
    58       * Tells if the current message has been encoded
    59       *
    60       * @return true if the message has already been encoded
    61       */
    62      boolean isEncoded();
    63  }