1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.net;
19
20 import java.net.DatagramSocket;
21 import java.net.InetAddress;
22 import java.net.SocketException;
23
24 /**
25 * The DatagramSocketFactory interface provides a means for the programmer to control the creation of datagram sockets and provide his own DatagramSocket
26 * implementations for use by all classes derived from {@link org.apache.commons.net.DatagramSocketClient} . This allows you to provide your own DatagramSocket
27 * implementations and to perform security checks or browser capability requests before creating a DatagramSocket.
28 */
29
30 public interface DatagramSocketFactory {
31
32 /**
33 * Creates a DatagramSocket on the local host at the first available port.
34 *
35 * @return the socket
36 *
37 * @throws SocketException If the socket could not be created.
38 */
39 DatagramSocket createDatagramSocket() throws SocketException;
40
41 /**
42 * Creates a DatagramSocket on the local host at a specified port.
43 *
44 * @param port The port to use for the socket.
45 * @return the socket
46 * @throws SocketException If the socket could not be created.
47 */
48 DatagramSocket createDatagramSocket(int port) throws SocketException;
49
50 /**
51 * Creates a DatagramSocket at the specified address on the local host at a specified port.
52 *
53 * @param port The port to use for the socket.
54 * @param localAddress The local address to use.
55 * @return the socket
56 * @throws SocketException If the socket could not be created.
57 */
58 DatagramSocket createDatagramSocket(int port, InetAddress localAddress) throws SocketException;
59 }