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   * The DatagramSocketFactory interface provides a means for the
26   * programmer to control the creation of datagram sockets and
27   * provide his own DatagramSocket implementations for use by all
28   * classes derived from
29   * {@link org.apache.commons.net.DatagramSocketClient}
30   * .
31   * This allows you to provide your own DatagramSocket implementations and
32   * to perform security checks or browser capability requests before
33   * creating a DatagramSocket.
34   *
35   *
36   ***/
37  
38  public interface DatagramSocketFactory
39  {
40  
41      /***
42       * Creates a DatagramSocket on the local host at the first available port.
43       * @return the socket
44       *
45       * @exception SocketException If the socket could not be created.
46       ***/
47      public DatagramSocket createDatagramSocket() throws SocketException;
48  
49      /***
50       * Creates a DatagramSocket on the local host at a specified port.
51       *
52       * @param port The port to use for the socket.
53       * @return the socket
54       * @exception SocketException If the socket could not be created.
55       ***/
56      public DatagramSocket createDatagramSocket(int port) throws SocketException;
57  
58      /***
59       * Creates a DatagramSocket at the specified address on the local host
60       * at a specified port.
61       *
62       * @param port The port to use for the socket.
63       * @param laddr  The local address to use.
64       * @return the socket
65       * @exception SocketException If the socket could not be created.
66       ***/
67      public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
68      throws SocketException;
69  }