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.util.Set;
24
25 import org.apache.mina.core.service.IoAcceptor;
26 import org.apache.mina.core.session.IoSession;
27 import org.apache.mina.core.session.IoSessionRecycler;
28
29 /**
30 * {@link IoAcceptor} for datagram transport (UDP/IP).
31 *
32 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
33 */
34 public interface DatagramAcceptor 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 * @return the {@link IoSessionRecycler} for this service.
63 */
64 IoSessionRecycler getSessionRecycler();
65
66 /**
67 * Sets the {@link IoSessionRecycler} for this service.
68 *
69 * @param sessionRecycler <tt>null</tt> to use the default recycler
70 */
71 void setSessionRecycler(IoSessionRecycler sessionRecycler);
72
73 /**
74 * @return the default Datagram configuration of the new {@link IoSession}s
75 * created by this service.
76 */
77 @Override
78 DatagramSessionConfig getSessionConfig();
79 }