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 connect requests.
    24   *
    25   * <h3>Example</h3>
    26   * <pre>
    27   * IoConnector connector = ...;
    28   * ConnectFuture future = connector.connect(...);
    29   * future.join(); // Wait until the connection attempt is finished.
    30   * IoSession session = future.getSession();
    31   * session.write(...);
    32   * </pre>
    33   *
    34   * @author The Apache Directory Project (mina-dev@directory.apache.org)
    35   * @version $Rev: 555855 $, $Date: 2007-07-13 05:19:00 +0200 (Fri, 13 Jul 2007) $
    36   */
    37  public interface ConnectFuture extends IoFuture {
    38      /**
    39       * Returns {@link IoSession} which is the result of connect operation.
    40       *
    41       * @return <tt>null</tt> if the connect operation is not finished yet
    42       * @throws RuntimeIOException if connection attempt failed by an exception
    43       */
    44      IoSession getSession() throws RuntimeIOException;
    45
    46      /**
    47       * Returns <tt>true</tt> if the connect operation is finished successfully.
    48       */
    49      boolean isConnected();
    50
    51      /**
    52       * Sets the newly connected session and notifies all threads waiting for
    53       * this future.  This method is invoked by MINA internally.  Please do not
    54       * call this method directly.
    55       */
    56      void setSession(IoSession session);
    57
    58      /**
    59       * Sets the exception caught due to connection failure and notifies all
    60       * threads waiting for this future.  This method is invoked by MINA
    61       * internally.  Please do not call this method directly.
    62       */
    63      void setException(Throwable exception);
    64  }