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.transport.socket; 21 22 import java.net.InetSocketAddress; 23 import java.net.ServerSocket; 24 import java.util.Set; 25 26 import org.apache.mina.core.service.IoAcceptor; 27 28 /** 29 * {@link IoAcceptor} for socket transport (TCP/IP). This class 30 * handles incoming TCP/IP based socket connections. 31 * 32 * @author <a href="http://mina.apache.org">Apache MINA Project</a> 33 */ 34 public interface SocketAcceptor extends IoAcceptor { 35 /** 36 * Returns the local InetSocketAddress which is bound currently. If more than one 37 * address are bound, only one of them will be returned, but it's not 38 * necessarily the firstly bound address. 39 * This method overrides the {@link IoAcceptor#getLocalAddress()} method. 40 */ 41 InetSocketAddress getLocalAddress(); 42 43 /** 44 * Returns a {@link Set} of the local InetSocketAddress which are bound currently. 45 * This method overrides the {@link IoAcceptor#getDefaultLocalAddress()} method. 46 */ 47 InetSocketAddress getDefaultLocalAddress(); 48 49 /** 50 * Sets the default local InetSocketAddress to bind when no argument is specified in 51 * {@link #bind()} method. Please note that the default will not be used 52 * if any local InetSocketAddress is specified. 53 * This method overrides the {@link IoAcceptor#setDefaultLocalAddress()} method. 54 */ 55 void setDefaultLocalAddress(InetSocketAddress localAddress); 56 57 /** 58 * @see ServerSocket#getReuseAddress() 59 */ 60 public boolean isReuseAddress(); 61 62 /** 63 * @see ServerSocket#setReuseAddress(boolean) 64 */ 65 public void setReuseAddress(boolean reuseAddress); 66 67 /** 68 * Returns the size of the backlog. 69 */ 70 public int getBacklog(); 71 72 /** 73 * Sets the size of the backlog. This can only be done when this 74 * class is not bound 75 */ 76 public void setBacklog(int backlog); 77 78 /** 79 * Returns the default configuration of the new SocketSessions created by 80 * this acceptor service. 81 */ 82 SocketSessionConfig getSessionConfig(); 83 }