DatagramPacket.java 12.7 KB
Newer Older
1 2
/* DatagramPacket.java -- Class to model a packet to be sent via UDP
   Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
3

4
This file is part of GNU Classpath.
5

6 7 8 9 10 11 12 13 14
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
15

16 17 18 19
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */
37

38
package java.net;
39

40
/*
41 42 43 44 45
 * Written using on-line Java Platform 1.2 API Specification, as well
 * as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
 * Status:  Believed complete and correct.
 */

46
/**
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
 * This class models a packet of data that is to be sent across the network
 * using a connectionless protocol such as UDP.  It contains the data
 * to be send, as well as the destination address and port.  Note that
 * datagram packets can arrive in any order and are not guaranteed to be
 * delivered at all.
 * <p>
 * This class can also be used for receiving data from the network.
 * <p>
 * Note that for all method below where the buffer length passed by the
 * caller cannot exceed the actually length of the byte array passed as
 * the buffer, if this condition is not true, then the method silently
 * reduces the length value to maximum allowable value.
 *
 * Written using on-line Java Platform 1.2 API Specification, as well
 * as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
 * Status:  Believed complete and correct.
 *
 * @author Warren Levy <warrenl@cygnus.com>
 * @author Aarom M. Renn (arenn@urbanophile.com) (Documentation comments)
 * @date April 28, 1999.
 */
68 69
public final class DatagramPacket
{
70 71 72
  /**
   * The data buffer to send
   */
73
  private byte[] buffer;
74

75 76 77
  /**
   * This is the offset into the buffer to start sending from or receiving to.
   */
78
  private int offset;
79

80 81 82
  /**
   * The length of the data buffer to send
   */
83
  private int length;
84

85 86 87 88
  /**
   * The address to which the packet should be sent or from which it
   * was received
   */
89
  private InetAddress address;
90

91 92 93 94
  /**
   * The port to which the packet should be sent or from which it was
   * was received.
   */
95 96
  private int port;

97 98 99 100 101 102 103 104 105 106
  /**
   * This method initializes a new instance of <code>DatagramPacket</code>
   * which has the specified buffer, offset, and length.
   *
   * @param buf The buffer for holding the incoming datagram.
   * @param offset The offset into the buffer to start writing.
   * @param length The maximum number of bytes to read.
   *
   * @since 1.2
   */
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
  public DatagramPacket(byte[] buf, int offset, int length)
  {
    if (buf == null)
      throw new NullPointerException("Null buffer");
    if (offset < 0)
      throw new IllegalArgumentException("Invalid offset: " + offset);
    if (length < 0)
      throw new IllegalArgumentException("Invalid length: " + length);
    if (offset + length > buf.length)
      throw new IllegalArgumentException("Potential buffer overflow - offset: "
			+ offset + " length: " + length);

    buffer = buf;
    this.offset = offset;
    this.length = length;
    this.address = null;
    this.port = -1;
  }

126 127 128 129 130 131 132
  /**
   * Initializes a new instance of <code>DatagramPacket</code> for
   * receiving packets from the network.
   *
   * @param buf A buffer for storing the returned packet data
   * @param length The length of the buffer (must be <= buf.length)
   */
133 134 135 136 137
  public DatagramPacket(byte[] buf, int length)
  {
    this(buf, 0, length);
  }

138 139 140 141 142 143 144 145 146 147 148 149
  /**
   * Initializes a new instance of <code>DatagramPacket</code> for
   * transmitting packets across the network.
   *
   * @param buf A buffer containing the data to send
   * @param offset The offset into the buffer to start writing from.
   * @param len The length of the buffer (must be <= buf.length)
   * @param addr The address to send to
   * @param port The port to send to
   *
   * @since 1.2
   */
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
  public DatagramPacket(byte[] buf, int offset, int length,
	InetAddress address, int port)
  {
    if (buf == null)
      throw new NullPointerException("Null buffer");
    if (offset < 0)
      throw new IllegalArgumentException("Invalid offset: " + offset);
    if (length < 0)
      throw new IllegalArgumentException("Invalid length: " + length);
    if (offset + length > buf.length)
      throw new IllegalArgumentException("Potential buffer overflow - offset: "
			+ offset + " length: " + length);
    if (port < 0 || port > 65535)
      throw new IllegalArgumentException("Invalid port: " + port);
    if (address == null)
      throw new NullPointerException("Null address");

    buffer = buf;
    this.offset = offset;
    this.length = length;
    this.address = address;
    this.port = port;
  }

174 175 176 177 178 179 180 181 182
  /**
   * Initializes a new instance of <code>DatagramPacket</code> for
   * transmitting packets across the network.
   *
   * @param buf A buffer containing the data to send
   * @param length The length of the buffer (must be <= buf.length)
   * @param address The address to send to
   * @param port The port to send to
   */
183 184 185 186 187
  public DatagramPacket(byte[] buf, int length, InetAddress address, int port)
  {
    this(buf, 0, length, address, port);
  }

188 189 190 191 192 193 194 195 196 197
  /**
   * Initializes a new instance of <code>DatagramPacket</code> for
   * transmitting packets across the network.
   *
   * @param buf A buffer containing the data to send
   * @param offset The offset into the buffer to start writing from.
   * @param length The length of the buffer (must be <= buf.length)
   * @param address The socket address to send to
   *
   * @exception SocketException If an error occurs
198
   * @exception IllegalArgumentException If address type is not supported
199 200 201
   *
   * @since 1.4
   */
202 203
  public DatagramPacket(byte[] buf, int offset, int length,
		        SocketAddress address)
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
     throws SocketException
  {
    this(buf, offset, length, ((InetSocketAddress)address).getAddress(),
         ((InetSocketAddress)address).getPort());
  }

  /**
   * Initializes a new instance of <code>DatagramPacket</code> for
   * transmitting packets across the network.
   *
   * @param buf A buffer containing the data to send
   * @param length The length of the buffer (must be <= buf.length)
   * @param address The socket address to send to
   *
   * @exception SocketException If an error occurs
219
   * @exception IllegalArgumentException If address type is not supported
220 221 222 223 224 225 226 227 228 229
   *
   * @since 1.4
   */
  public DatagramPacket(byte[] buf, int length, SocketAddress address)
    throws SocketException
  {
    this(buf, 0, length, ((InetSocketAddress)address).getAddress(),
         ((InetSocketAddress)address).getPort());
  }

230 231 232 233 234 235 236 237 238
  /**
   * 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
   * constructor that doesn not take an address was used to create this object
   * and no packet was actually read into this object, then this method
   * returns <code>null</code>.
   *
   * @return The address for this packet.
   */
239 240 241 242 243
  public synchronized InetAddress getAddress()
  {
    return address;
  }

244 245 246 247 248 249 250 251 252
  /**
   * 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
   * constructor that doesn not take an address was used to create this object
   * and no packet was actually read into this object, then this method
   * will return 0.
   *
   * @return The port number for this packet
   */
253 254 255 256 257
  public synchronized int getPort()
  {
    return port;
  }

258 259 260 261 262
  /**
   * Returns the data buffer for this packet
   *
   * @return This packet's data buffer
   */
263 264 265 266 267
  public synchronized byte[] getData()
  {
    return buffer;
  }

268 269 270 271 272 273 274 275
  /**
   * This method returns the current offset value into the data buffer
   * where data will be sent from.
   *
   * @return The buffer offset.
   *
   * @since 1.2
   */
276 277 278 279 280
  public synchronized int getOffset()
  {
    return offset;
  }

281 282 283 284 285
  /**
   * Returns the length of the data in the buffer
   *
   * @return The length of the data
   */
286 287 288 289 290
  public synchronized int getLength()
  {
    return length;
  }

291 292 293 294 295 296 297
  /**
   * This sets the address to which the data packet will be transmitted.
   *
   * @param addr The destination address
   *
   * @since 1.1
   */
298 299 300 301 302 303 304 305
  public synchronized void setAddress(InetAddress iaddr)
  {
    if (iaddr == null)
      throw new NullPointerException("Null address");

    address = iaddr;
  }

306 307 308 309 310 311 312
  /**
   * This sets the port to which the data packet will be transmitted.
   *
   * @param port The destination port
   *
   * @since 1.1
   */
313 314 315 316 317 318 319 320
  public synchronized void setPort(int iport)
  {
    if (iport < 0 || iport > 65535)
      throw new IllegalArgumentException("Invalid port: " + iport);

    port = iport;
  }

321 322 323 324 325
  /**
   * Sets the address of the remote host this package will be sent
   *
   * @param address The socket address of the remove host
   *
326
   * @exception IllegalArgumentException If address type is not supported
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
   *
   * @since 1.4
   */
  public void setSocketAddress(SocketAddress address)
    throws IllegalArgumentException
  {
    if (address == null) throw new IllegalArgumentException();

    InetSocketAddress tmp = (InetSocketAddress)address;
    this.address = tmp.getAddress();
    this.port = tmp.getPort();
  }

  /**
   * Gets the socket address of the host this packet
   * will be sent to/is coming from
   *
   * @return The socket address of the remote host
   * 
   * @since 1.4
   */
  public SocketAddress getSocketAddress()
  {
    return new InetSocketAddress (address, port);
  }

353 354 355 356 357
  /**
   * Sets the data buffer for this packet.
   *
   * @param buf The new buffer for this packet
   *
358 359
   * @exception NullPointerException If the argument is null
   *
360 361
   * @since 1.1
   */
362 363 364 365 366 367 368 369 370 371
  public synchronized void setData(byte[] buf)
  {
    // This form of setData requires setLength to be called separately
    // and subsequently.
    if (buf == null)
      throw new NullPointerException("Null buffer");

    buffer = buf;
  }

372 373 374 375 376 377 378
  /**
   * This method sets the data buffer for the packet.
   *
   * @param buf The byte array containing the data for this packet.
   * @param offset The offset into the buffer to start reading data from.
   * @param length The number of bytes of data in the buffer.
   *
379 380
   * @exception NullPointerException If the argument is null
   *
381 382
   * @since 1.2
   */
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
  public synchronized void setData(byte[] buf, int offset, int length)
  {
    // This form of setData must be used if offset is to be changed.

    if (buf == null)
      throw new NullPointerException("Null buffer");
    if (offset < 0)
      throw new IllegalArgumentException("Invalid offset: " + offset);
    if (length < 0)
      throw new IllegalArgumentException("Invalid length: " + length);
    if (offset + length > buf.length)
      throw new IllegalArgumentException("Potential buffer overflow - offset: "
			+ offset + " length: " + length);

    buffer = buf;
    this.offset = offset;
    this.length = length;
  }

402 403 404
  /**
   * Sets the length of the data in the buffer. 
   *
405
   * @param length The new length.  (Where len &lt;= buf.length)
406
   *
407
   * @exception IllegalArgumentException If the length is negative or
408 409
   * if the length is greater than the packet's data buffer length
   *
410 411
   * @since 1.1
   */
412 413 414 415 416 417 418 419 420 421
  public synchronized void setLength(int length)
  {
    if (length < 0)
      throw new IllegalArgumentException("Invalid length: " + length);
    if (offset + length > buffer.length)
      throw new IllegalArgumentException("Potential buffer overflow - offset: "
			+ offset + " length: " + length);

    this.length = length;
  }
422 423
} // class DatagramPacket