Skip to content

R
riscv-gcc-1
Commit 603f86d7 by Michael Koch Committed by Michael Koch
Options

DatagramPacket.java, [...]: re-indented documentation. 

2002-09-02  Michael Koch  <konqueror@gmx.de>

	* java/net/DatagramPacket.java, java/net/MulticsstSocket.java:
	re-indented documentation.

From-SVN: r56739
parent e53fbf8a
Showing with 43 additions and 39 deletions
libjava/ChangeLog
2002-09-02 Michael Koch <konqueror@gmx.de>
* java/net/DatagramPacket.java, java/net/MulticsstSocket.java:
re-indented documentation.
2002-08-30 Jesse Rosenstock <jmr@ugcs.caltech.edu> 2002-08-30 Jesse Rosenstock <jmr@ugcs.caltech.edu>
* java/util/Calendar.java (getTimeInMillis, getTimeInMillis): Now * java/util/Calendar.java (getTimeInMillis, getTimeInMillis): Now
......
libjava/java/net/DatagramPacket.java
...@@ -65,37 +65,36 @@ package java.net; ...@@ -65,37 +65,36 @@ package java.net;
* @author Aarom M. Renn (arenn@urbanophile.com) (Documentation comments) * @author Aarom M. Renn (arenn@urbanophile.com) (Documentation comments)
* @date April 28, 1999. * @date April 28, 1999.
*/ */
public final class DatagramPacket public final class DatagramPacket
{ {
/** /**
* The data buffer to send * The data buffer to send
*/ */
private byte[] buffer; private byte[] buffer;
/** /**
* This is the offset into the buffer to start sending from or receiving to. * This is the offset into the buffer to start sending from or receiving to.
*/ */
private int offset; private int offset;
/** /**
* The length of the data buffer to send * The length of the data buffer to send
*/ */
private int length; private int length;
/** /**
* The address to which the packet should be sent or from which it * The address to which the packet should be sent or from which it
* was received * was received
*/ */
private InetAddress address; private InetAddress address;
/** /**
* The port to which the packet should be sent or from which it was * The port to which the packet should be sent or from which it was
* was received. * was received.
*/ */
private int port; private int port;
/** /**
* This method initializes a new instance of <code>DatagramPacket</code> * This method initializes a new instance of <code>DatagramPacket</code>
* which has the specified buffer, offset, and length. * which has the specified buffer, offset, and length.
* *
...@@ -124,7 +123,7 @@ public final class DatagramPacket ...@@ -124,7 +123,7 @@ public final class DatagramPacket
this.port = -1; this.port = -1;
} }
/** /**
* Initializes a new instance of <code>DatagramPacket</code> for * Initializes a new instance of <code>DatagramPacket</code> for
* receiving packets from the network. * receiving packets from the network.
* *
...@@ -136,7 +135,7 @@ public final class DatagramPacket ...@@ -136,7 +135,7 @@ public final class DatagramPacket
this(buf, 0, length); this(buf, 0, length);
} }
/** /**
* Initializes a new instance of <code>DatagramPacket</code> for * Initializes a new instance of <code>DatagramPacket</code> for
* transmitting packets across the network. * transmitting packets across the network.
* *
...@@ -172,7 +171,7 @@ public final class DatagramPacket ...@@ -172,7 +171,7 @@ public final class DatagramPacket
this.port = port; this.port = port;
} }
/** /**
* Initializes a new instance of <code>DatagramPacket</code> for * Initializes a new instance of <code>DatagramPacket</code> for
* transmitting packets across the network. * transmitting packets across the network.
* *
...@@ -225,7 +224,7 @@ public final class DatagramPacket ...@@ -225,7 +224,7 @@ public final class DatagramPacket
((InetSocketAddress)address).getPort()); ((InetSocketAddress)address).getPort());
} }
/** /**
* Returns the address that this packet is being sent to or, if it was used * Returns the address that this packet is being sent to or, if it was used
* to receive a packet, the address that is was received from. If the * to receive a packet, the address that is was received from. If the
* constructor that doesn not take an address was used to create this object * constructor that doesn not take an address was used to create this object
...@@ -239,7 +238,7 @@ public final class DatagramPacket ...@@ -239,7 +238,7 @@ public final class DatagramPacket
return address; return address;
} }
/** /**
* Returns the port number this packet is being sent to or, if it was used * Returns the port number this packet is being sent to or, if it was used
* to receive a packet, the port that it was received from. If the * to receive a packet, the port that it was received from. If the
* constructor that doesn not take an address was used to create this object * constructor that doesn not take an address was used to create this object
...@@ -253,7 +252,7 @@ public final class DatagramPacket ...@@ -253,7 +252,7 @@ public final class DatagramPacket
return port; return port;
} }
/** /**
* Returns the data buffer for this packet * Returns the data buffer for this packet
* *
* @return This packet's data buffer * @return This packet's data buffer
...@@ -263,7 +262,7 @@ public final class DatagramPacket ...@@ -263,7 +262,7 @@ public final class DatagramPacket
return buffer; return buffer;
} }
/** /**
* This method returns the current offset value into the data buffer * This method returns the current offset value into the data buffer
* where data will be sent from. * where data will be sent from.
* *
...@@ -276,7 +275,7 @@ public final class DatagramPacket ...@@ -276,7 +275,7 @@ public final class DatagramPacket
return offset; return offset;
} }
/** /**
* Returns the length of the data in the buffer * Returns the length of the data in the buffer
* *
* @return The length of the data * @return The length of the data
...@@ -286,7 +285,7 @@ public final class DatagramPacket ...@@ -286,7 +285,7 @@ public final class DatagramPacket
return length; return length;
} }
/** /**
* This sets the address to which the data packet will be transmitted. * This sets the address to which the data packet will be transmitted.
* *
* @param addr The destination address * @param addr The destination address
...@@ -301,7 +300,7 @@ public final class DatagramPacket ...@@ -301,7 +300,7 @@ public final class DatagramPacket
address = iaddr; address = iaddr;
} }
/** /**
* This sets the port to which the data packet will be transmitted. * This sets the port to which the data packet will be transmitted.
* *
* @param port The destination port * @param port The destination port
...@@ -348,7 +347,7 @@ public final class DatagramPacket ...@@ -348,7 +347,7 @@ public final class DatagramPacket
return new InetSocketAddress (address, port); return new InetSocketAddress (address, port);
} }
/** /**
* Sets the data buffer for this packet. * Sets the data buffer for this packet.
* *
* @param buf The new buffer for this packet * @param buf The new buffer for this packet
...@@ -365,7 +364,7 @@ public final class DatagramPacket ...@@ -365,7 +364,7 @@ public final class DatagramPacket
buffer = buf; buffer = buf;
} }
/** /**
* This method sets the data buffer for the packet. * This method sets the data buffer for the packet.
* *
* @param buf The byte array containing the data for this packet. * @param buf The byte array containing the data for this packet.
...@@ -393,7 +392,7 @@ public final class DatagramPacket ...@@ -393,7 +392,7 @@ public final class DatagramPacket
this.length = length; this.length = length;
} }
/** /**
* Sets the length of the data in the buffer. * Sets the length of the data in the buffer.
* *
* @param length The new length. (Where len <= buf.length) * @param length The new length. (Where len <= buf.length)
......
libjava/java/net/MulticastSocket.java
...@@ -39,7 +39,7 @@ package java.net; ...@@ -39,7 +39,7 @@ package java.net;
import java.io.IOException; import java.io.IOException;
/* /**
* Written using on-line Java Platform 1.2 API Specification, as well * Written using on-line Java Platform 1.2 API Specification, as well
* as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998). * as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
* Status: Believed complete and correct. * Status: Believed complete and correct.
...@@ -69,7 +69,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -69,7 +69,7 @@ public class MulticastSocket extends DatagramSocket
// unlike unicast sockets. It binds to any available network interface. // unlike unicast sockets. It binds to any available network interface.
// See p.1159 JCL book. // See p.1159 JCL book.
/** /**
* Create a MulticastSocket that this not bound to any address * Create a MulticastSocket that this not bound to any address
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
...@@ -79,10 +79,10 @@ public class MulticastSocket extends DatagramSocket ...@@ -79,10 +79,10 @@ public class MulticastSocket extends DatagramSocket
super(0, null); super(0, null);
} }
/** /**
* Create a multicast socket bound to the specified port * Create a multicast socket bound to the specified port
* *
* @param The port to bind to * @param port The port to bind to
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
...@@ -91,7 +91,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -91,7 +91,7 @@ public class MulticastSocket extends DatagramSocket
super(port, null); super(port, null);
} }
/** /**
* Returns the interface being used for multicast packets * Returns the interface being used for multicast packets
* *
* @return The multicast interface * @return The multicast interface
...@@ -104,7 +104,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -104,7 +104,7 @@ public class MulticastSocket extends DatagramSocket
return (InetAddress) impl.getOption(SocketOptions.IP_MULTICAST_IF); return (InetAddress) impl.getOption(SocketOptions.IP_MULTICAST_IF);
} }
/** /**
* Returns the current value of the "Time to Live" option. This is the * Returns the current value of the "Time to Live" option. This is the
* number of hops a packet can make before it "expires". This method id * number of hops a packet can make before it "expires". This method id
* deprecated. Use <code>getTimeToLive</code> instead. * deprecated. Use <code>getTimeToLive</code> instead.
...@@ -113,7 +113,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -113,7 +113,7 @@ public class MulticastSocket extends DatagramSocket
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
* *
* @deprecated Replaced by getTimeToLive() in Java 1.2 * @deprecated 1.2 Replaced by getTimeToLive()
*/ */
public byte getTTL() throws IOException public byte getTTL() throws IOException
{ {
...@@ -123,7 +123,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -123,7 +123,7 @@ public class MulticastSocket extends DatagramSocket
return impl.getTTL(); return impl.getTTL();
} }
/** /**
* Returns the current value of the "Time to Live" option. This is the * Returns the current value of the "Time to Live" option. This is the
* number of hops a packet can make before it "expires". * number of hops a packet can make before it "expires".
* *
...@@ -131,17 +131,17 @@ public class MulticastSocket extends DatagramSocket ...@@ -131,17 +131,17 @@ public class MulticastSocket extends DatagramSocket
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
* *
* @since Java 1.2 * @since 1.2
*/ */
public int getTimeToLive() throws IOException public int getTimeToLive() throws IOException
{ {
return impl.getTimeToLive(); return impl.getTimeToLive();
} }
/** /**
* Sets the interface to use for multicast packets. * Sets the interface to use for sending multicast packets.
* *
* @param addr The new interface to use * @param inf The new interface to use
* *
* @exception SocketException If an error occurs * @exception SocketException If an error occurs
*/ */
...@@ -150,7 +150,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -150,7 +150,7 @@ public class MulticastSocket extends DatagramSocket
impl.setOption(SocketOptions.IP_MULTICAST_IF, inf); impl.setOption(SocketOptions.IP_MULTICAST_IF, inf);
} }
/** /**
* Sets the "Time to Live" value for a socket. The value must be between * Sets the "Time to Live" value for a socket. The value must be between
* 1 and 255. * 1 and 255.
* *
...@@ -158,7 +158,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -158,7 +158,7 @@ public class MulticastSocket extends DatagramSocket
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
* *
* @deprecated Replaced by <code>setTimeToLive</code> in Java 1.2 * @deprecated 1.2 Replaced by <code>setTimeToLive</code>
*/ */
public void setTTL(byte ttl) throws IOException public void setTTL(byte ttl) throws IOException
{ {
...@@ -168,7 +168,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -168,7 +168,7 @@ public class MulticastSocket extends DatagramSocket
impl.setTTL(ttl); impl.setTTL(ttl);
} }
/** /**
* Sets the "Time to Live" value for a socket. The value must be between * Sets the "Time to Live" value for a socket. The value must be between
* 1 and 255. * 1 and 255.
* *
...@@ -176,7 +176,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -176,7 +176,7 @@ public class MulticastSocket extends DatagramSocket
* *
* @exception IOException If an error occurs * @exception IOException If an error occurs
* *
* @since Java 1.2 * @since 1.2
*/ */
public void setTimeToLive(int ttl) throws IOException public void setTimeToLive(int ttl) throws IOException
{ {
...@@ -186,7 +186,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -186,7 +186,7 @@ public class MulticastSocket extends DatagramSocket
impl.setTimeToLive(ttl); impl.setTimeToLive(ttl);
} }
/** /**
* Joins the specified mulitcast group. * Joins the specified mulitcast group.
* *
* @param addr The address of the group to join * @param addr The address of the group to join
...@@ -205,7 +205,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -205,7 +205,7 @@ public class MulticastSocket extends DatagramSocket
impl.join(mcastaddr); impl.join(mcastaddr);
} }
/** /**
* Leaves the specified multicast group * Leaves the specified multicast group
* *
* @param addr The address of the group to leave * @param addr The address of the group to leave
...@@ -224,7 +224,7 @@ public class MulticastSocket extends DatagramSocket ...@@ -224,7 +224,7 @@ public class MulticastSocket extends DatagramSocket
impl.leave(mcastaddr); impl.leave(mcastaddr);
} }
/** /**
* Sends a packet of data to a multicast address with a TTL that is * Sends a packet of data to a multicast address with a TTL that is
* different from the default TTL on this socket. The default TTL for * different from the default TTL on this socket. The default TTL for
* the socket is not changed. * the socket is not changed.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment