1. /*

  2.  * @(#)DatagramSocketImpl.java	1.32 04/05/18

  3.  *

  4.  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package java.net;

  9. 

  10. import java.io.FileDescriptor;

  11. import java.io.IOException;

  12. import java.io.InterruptedIOException;

  13. 

  14. /**

  15.  * Abstract datagram and multicast socket implementation base class.

  16.  * @author Pavani Diwanji

  17.  * @since  JDK1.1

  18.  */

  19. 

  20. public abstract class DatagramSocketImpl implements SocketOptions {

  21. 

  22.     /**

  23.      * The local port number.

  24.      */   

  25.     protected int localPort;

  26. 

  27.     /**

  28.      * The file descriptor object.

  29.      */

  30.     protected FileDescriptor fd;

  31. 

  32.     /**

  33.      * Creates a datagram socket.

  34.      * @exception SocketException if there is an error in the 

  35.      * underlying protocol, such as a TCP error. 

  36.      */

  37.     protected abstract void create() throws SocketException;

  38. 

  39.     /**

  40.      * Binds a datagram socket to a local port and address.

  41.      * @param lport the local port

  42.      * @param laddr the local address

  43.      * @exception SocketException if there is an error in the

  44.      * underlying protocol, such as a TCP error.

  45.      */

  46.     protected abstract void bind(int lport, InetAddress laddr) throws SocketException;

  47. 

  48.     /**

  49.      * Sends a datagram packet. The packet contains the data and the

  50.      * destination address to send the packet to.

  51.      * @param p the packet to be sent.

  52.      * @exception IOException if an I/O exception occurs while sending the 

  53.      * datagram packet.

  54.      * @exception  PortUnreachableException may be thrown if the socket is connected

  55.      * to a currently unreachable destination. Note, there is no guarantee that 

  56.      * the exception will be thrown.

  57.      */

  58.     protected abstract void send(DatagramPacket p) throws IOException;

  59. 

  60.     /**

  61.      * Connects a datagram socket to a remote destination. This associates the remote

  62.      * address with the local socket so that datagrams may only be sent to this destination

  63.      * and received from this destination. This may be overridden to call a native

  64.      * system connect. 

  65.      *

  66.      * <p>If the remote destination to which the socket is connected does not

  67.      * exist, or is otherwise unreachable, and if an ICMP destination unreachable

  68.      * packet has been received for that address, then a subsequent call to 

  69.      * send or receive may throw a PortUnreachableException. 

  70.      * Note, there is no guarantee that the exception will be thrown.

  71.      * @param address the remote InetAddress to connect to

  72.      * @param port the remote port number

  73.      * @exception   SocketException may be thrown if the socket cannot be

  74.      * connected to the remote destination

  75.      * @since 1.4

  76.      */

  77.     protected void connect(InetAddress address, int port) throws SocketException {}

  78. 

  79.     /**

  80.      * Disconnects a datagram socket from its remote destination. 

  81.      * @since 1.4

  82.      */

  83.     protected void disconnect() {}

  84. 

  85.     /**

  86.      * Peek at the packet to see who it is from.

  87.      * @param i an InetAddress object 

  88.      * @return the address which the packet came from.

  89.      * @exception IOException if an I/O exception occurs

  90.      * @exception  PortUnreachableException may be thrown if the socket is connected

  91.      *       to a currently unreachable destination. Note, there is no guarantee that the

  92.      *       exception will be thrown.

  93.      */

  94.     protected abstract int peek(InetAddress i) throws IOException;

  95. 

  96.     /**

  97.      * Peek at the packet to see who it is from. The data is returned,

  98.      * but not consumed, so that a subsequent peekData/receive operation 

  99.      * will see the same data.

  100.      * @param p the Packet Received.

  101.      * @return the address which the packet came from.

  102.      * @exception IOException if an I/O exception occurs

  103.      * @exception  PortUnreachableException may be thrown if the socket is connected

  104.      *       to a currently unreachable destination. Note, there is no guarantee that the

  105.      *       exception will be thrown.

  106.      * @since 1.4

  107.      */

  108.     protected abstract int peekData(DatagramPacket p) throws IOException;

  109.     /**

  110.      * Receive the datagram packet.

  111.      * @param p the Packet Received.

  112.      * @exception IOException if an I/O exception occurs

  113.      * while receiving the datagram packet.

  114.      * @exception  PortUnreachableException may be thrown if the socket is connected

  115.      *       to a currently unreachable destination. Note, there is no guarantee that the

  116.      *       exception will be thrown.

  117.      */

  118.     protected abstract void receive(DatagramPacket p) throws IOException;

  119. 

  120.     /**

  121.      * Set the TTL (time-to-live) option.

  122.      * @param ttl a byte specifying the TTL value

  123.      *

  124.      * @deprecated use setTimeToLive instead.

  125.      * @exception IOException if an I/O exception occurs while setting

  126.      * the time-to-live option.

  127.      * @see #getTTL()

  128.      */

  129.     @Deprecated

  130.     protected abstract void setTTL(byte ttl) throws IOException;

  131. 

  132.     /**

  133.      * Retrieve the TTL (time-to-live) option.

  134.      *

  135.      * @exception IOException if an I/O exception occurs

  136.      * while retrieving the time-to-live option

  137.      * @deprecated use getTimeToLive instead.

  138.      * @return a byte representing the TTL value

  139.      * @see #setTTL(byte)

  140.      */

  141.     @Deprecated

  142.     protected abstract byte getTTL() throws IOException;

  143. 

  144.     /**

  145.      * Set the TTL (time-to-live) option.

  146.      * @param ttl an <tt>int</tt> specifying the time-to-live value

  147.      * @exception IOException if an I/O exception occurs

  148.      * while setting the time-to-live option.

  149.      * @see #getTimeToLive()

  150.      */

  151.     protected abstract void setTimeToLive(int ttl) throws IOException;

  152. 

  153.     /**

  154.      * Retrieve the TTL (time-to-live) option.

  155.      * @exception IOException if an I/O exception occurs

  156.      * while retrieving the time-to-live option

  157.      * @return an <tt>int</tt> representing the time-to-live value

  158.      * @see #setTimeToLive(int)

  159.      */

  160.     protected abstract int getTimeToLive() throws IOException;

  161. 

  162.     /**

  163.      * Join the multicast group.

  164.      * @param inetaddr multicast address to join.

  165.      * @exception IOException if an I/O exception occurs

  166.      * while joining the multicast group.

  167.      */

  168.     protected abstract void join(InetAddress inetaddr) throws IOException;

  169. 

  170.     /**

  171.      * Leave the multicast group.

  172.      * @param inetaddr multicast address to leave.

  173.      * @exception IOException if an I/O exception occurs

  174.      * while leaving the multicast group.

  175.      */

  176.     protected abstract void leave(InetAddress inetaddr) throws IOException;

  177. 

  178.     /**

  179.      * Join the multicast group.

  180.      * @param mcastaddr address to join.

  181.      * @param netIf specifies the local interface to receive multicast

  182.      *        datagram packets

  183.      * @throws IOException if an I/O exception occurs while joining

  184.      * the multicast group

  185.      * @since 1.4

  186.      */

  187.     protected abstract void joinGroup(SocketAddress mcastaddr,

  188. 				      NetworkInterface netIf) 

  189. 	throws IOException;

  190. 

  191.     /**

  192.      * Leave the multicast group.

  193.      * @param mcastaddr address to leave.

  194.      * @param netIf specified the local interface to leave the group at

  195.      * @throws IOException if an I/O exception occurs while leaving

  196.      * the multicast group

  197.      * @since 1.4

  198.      */

  199.     protected abstract void leaveGroup(SocketAddress mcastaddr, 

  200. 				       NetworkInterface netIf) 

  201. 	throws IOException;

  202. 

  203.     /**

  204.      * Close the socket.

  205.      */

  206.     protected abstract void close();

  207. 

  208.     /**

  209.      * Gets the local port.

  210.      * @return an <tt>int</tt> representing the local port value

  211.      */

  212.     protected int getLocalPort() {

  213. 	return localPort;

  214.     }

  215. 

  216.     /**

  217.      * Gets the datagram socket file descriptor.

  218.      * @return a <tt>FileDescriptor</tt> object representing the datagram socket

  219.      * file descriptor

  220.      */

  221.     protected FileDescriptor getFileDescriptor() {

  222. 	return fd;

  223.     }

  224. }