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   * 
26   * A network server bound to a local address.
27   * <p>
28   * Will crate a new {@link IoSession} for each new incoming connection.
29   * 
30   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
31   * 
32   */
33  public interface IoServer {
34      /**
35       * Returns the local addresses which are bound currently.
36       */
37      SocketAddress getBoundAddress();
38  
39      /**
40       * Binds to the specified local addresses and start to accept incoming connections.
41       */
42      void bind(SocketAddress localAddress);
43  
44      /**
45       * Binds the server to the specified port.
46       * 
47       * @param port the local TCP port to bind.
48       */
49      void bind(int port);
50  
51      /**
52       * Unbinds from the local addresses that this service is bound to and stops to accept incoming connections. This
53       * method returns silently if no local address is bound yet.
54       * 
55       */
56      void unbind();
57  }