001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net;
019
020import java.net.DatagramSocket;
021import java.net.InetAddress;
022import java.net.SocketException;
023
024/**
025 * The DatagramSocketFactory interface provides a means for the programmer to control the creation of datagram sockets and provide his own DatagramSocket
026 * implementations for use by all classes derived from {@link org.apache.commons.net.DatagramSocketClient} . This allows you to provide your own DatagramSocket
027 * implementations and to perform security checks or browser capability requests before creating a DatagramSocket.
028 *
029 *
030 */
031
032public interface DatagramSocketFactory {
033
034    /**
035     * Creates a DatagramSocket on the local host at the first available port.
036     *
037     * @return the socket
038     *
039     * @throws SocketException If the socket could not be created.
040     */
041    DatagramSocket createDatagramSocket() throws SocketException;
042
043    /**
044     * Creates a DatagramSocket on the local host at a specified port.
045     *
046     * @param port The port to use for the socket.
047     * @return the socket
048     * @throws SocketException If the socket could not be created.
049     */
050    DatagramSocket createDatagramSocket(int port) throws SocketException;
051
052    /**
053     * Creates a DatagramSocket at the specified address on the local host at a specified port.
054     *
055     * @param port  The port to use for the socket.
056     * @param laddr The local address to use.
057     * @return the socket
058     * @throws SocketException If the socket could not be created.
059     */
060    DatagramSocket createDatagramSocket(int port, InetAddress laddr) throws SocketException;
061}