1 package org.apache.commons.net;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Commons" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import java.net.DatagramSocket;
58 import java.net.InetAddress;
59 import java.net.SocketException;
60
61 /****
62 * The DatagramSocketFactory interface provides a means for the
63 * programmer to control the creation of datagram sockets and
64 * provide his own DatagramSocket implementations for use by all
65 * classes derived from
66 * <a href="org.apache.commons.net.DatagramSocketClient.html">
67 * DatagramSocketClient </a>.
68 * This allows you to provide your own DatagramSocket implementations and
69 * to perform security checks or browser capability requests before
70 * creating a DatagramSocket.
71 * <p>
72 * <p>
73 * @author Daniel F. Savarese
74 ***/
75
76 public interface DatagramSocketFactory
77 {
78
79 /****
80 * Creates a DatagramSocket on the local host at the first available port.
81 * <p>
82 * @exception SocketException If the socket could not be created.
83 ***/
84 public DatagramSocket createDatagramSocket() throws SocketException;
85
86 /****
87 * Creates a DatagramSocket on the local host at a specified port.
88 * <p>
89 * @param port The port to use for the socket.
90 * @exception SocketException If the socket could not be created.
91 ***/
92 public DatagramSocket createDatagramSocket(int port) throws SocketException;
93
94 /****
95 * Creates a DatagramSocket at the specified address on the local host
96 * at a specified port.
97 * <p>
98 * @param port The port to use for the socket.
99 * @param laddr The local address to use.
100 * @exception SocketException If the socket could not be created.
101 ***/
102 public DatagramSocket createDatagramSocket(int port, InetAddress laddr)
103 throws SocketException;
104 }
This page was automatically generated by Maven