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 * @return 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 @Override
42 InetSocketAddress getLocalAddress();
43
44 /**
45 * @return a {@link Set} of the local InetSocketAddress which are bound currently.
46 * This method overrides the {@link IoAcceptor#getDefaultLocalAddress()} method.
47 */
48 @Override
49 InetSocketAddress getDefaultLocalAddress();
50
51 /**
52 * Sets the default local InetSocketAddress to bind when no argument is specified in
53 * {@link #bind()} method. Please note that the default will not be used
54 * if any local InetSocketAddress is specified.
55 * This method overrides the {@link IoAcceptor#setDefaultLocalAddress(java.net.SocketAddress)} method.
56 *
57 * @param localAddress The local address
58 */
59 void setDefaultLocalAddress(InetSocketAddress localAddress);
60
61 /**
62 * @see ServerSocket#getReuseAddress()
63 *
64 * @return <tt>true</tt> if the <tt>SO_REUSEADDR</tt> is enabled
65 */
66 boolean isReuseAddress();
67
68 /**
69 * @see ServerSocket#setReuseAddress(boolean)
70 *
71 * @param reuseAddress tells if the <tt>SO_REUSEADDR</tt> is to be enabled
72 */
73 void setReuseAddress(boolean reuseAddress);
74
75 /**
76 * @return the size of the backlog.
77 */
78 int getBacklog();
79
80 /**
81 * Sets the size of the backlog. This can only be done when this
82 * class is not bound
83 *
84 * @param backlog The backlog's size
85 */
86 void setBacklog(int backlog);
87
88 /**
89 * @return the default configuration of the new SocketSessions created by
90 * this acceptor service.
91 */
92 @Override
93 SocketSessionConfig getSessionConfig();
94 }