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.common;
    21
    22  /**
    23   * An {@link IoFuture} for asynchronous write requests.
    24   *
    25   * <h3>Example</h3>
    26   * <pre>
    27   * IoSession session = ...;
    28   * WriteFuture future = session.write(...);
    29   * // Wait until the message is completely written out to the O/S buffer.
    30   * future.join();
    31   * if( future.isWritten() )
    32   * {
    33   *     // The message has been written successfully.
    34   * }
    35   * else
    36   * {
    37   *     // The messsage couldn't be written out completely for some reason.
    38   *     // (e.g. Connection is closed)
    39   * }
    40   * </pre>
    41   *
    42   * @author The Apache Directory Project (mina-dev@directory.apache.org)
    43   * @version $Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $
    44   */
    45  public interface WriteFuture extends IoFuture {
    46      /**
    47       * Returns <tt>true</tt> if the write operation is finished successfully.
    48       */
    49      boolean isWritten();
    50
    51      /**
    52       * Sets whether the message is written or not, and notifies all threads
    53       * waiting for this future.  This method is invoked by MINA internally.
    54       * Please do not call this method directly.
    55       */
    56      void setWritten(boolean written);
    57  }