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.api;
21  
22  import java.net.SocketAddress;
23  
24  /**
25   * Connects to several end-points, communicates with the server, and fires events to
26   * {@link org.apache.mina.service.IoHandler}s.
27   * 
28   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
29   */
30  public interface IoClient {
31  
32      /**
33       * Connects to the specified remote address.
34       * 
35       * @param remoteAddress Remote {@link SocketAddress} to connect
36       * @return the {@link IoFuture} instance which is completed when the connection attempt initiated by this call
37       *         succeeds or fails.
38       */
39      IoFuture<IoSession> connect(SocketAddress remoteAddress);
40  }