View Javadoc

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   * DefaultDatagramSocketFactory implements the DatagramSocketFactory
26   * interface by simply wrapping the java.net.DatagramSocket
27   * constructors.  It is the default DatagramSocketFactory used by
28   * {@link org.apache.commons.net.DatagramSocketClient}
29   *  implementations.
30   * <p>
31   * <p>
32   * @author Daniel F. Savarese
33   * @see DatagramSocketFactory
34   * @see DatagramSocketClient
35   * @see DatagramSocketClient#setDatagramSocketFactory
36   ***/
37  
38  public class DefaultDatagramSocketFactory implements DatagramSocketFactory
39  {
40  
41      /***
42       * Creates a DatagramSocket on the local host at the first available port.
43       * <p>
44       * @exception SocketException If the socket could not be created.
45       ***/
46      public DatagramSocket createDatagramSocket() throws SocketException
47      {
48          return new DatagramSocket();
49      }
50  
51      /***
52       * Creates a DatagramSocket on the local host at a specified port.
53       * <p>
54       * @param port The port to use for the socket.
55       * @exception SocketException If the socket could not be created.
56       ***/
57      public DatagramSocket createDatagramSocket(int port) throws SocketException
58      {
59          return new DatagramSocket(port);
60      }
61  
62      /***
63       * Creates a DatagramSocket at the specified address on the local host
64       * at a specified port.
65       * <p>
66       * @param port The port to use for the socket.
67       * @param laddr  The local address to use.
68       * @exception SocketException If the socket could not be created.
69       ***/
70      public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
71      throws SocketException
72      {
73          return new DatagramSocket(port, laddr);
74      }
75  }