org.apache.commons.net.tftp

## Class TFTPReadRequestPacket

- java.lang.Object
- - org.apache.commons.net.tftp.TFTPPacket
  - - org.apache.commons.net.tftp.TFTPRequestPacket
    - - org.apache.commons.net.tftp.TFTPReadRequestPacket

-     public final class TFTPReadRequestPacket
      extends TFTPRequestPacket

  A class derived from TFTPRequestPacket defining a TFTP read request packet type.

  Details regarding the TFTP protocol and the format of TFTP packets can be found in RFC 783. But the point of these classes is to keep you from having to worry about the internals. Additionally, only very few people should have to care about any of the TFTPPacket classes or derived classes. Almost all users should only be concerned with the `TFTPClient` class `receiveFile()` and `sendFile()` methods.

  See Also:
    `TFTPPacket`, `TFTPRequestPacket`, `TFTPPacketException`, `TFTP`

- - ### Field Summary

    - ### Fields inherited from class org.apache.commons.net.tftp.TFTPRequestPacket

      `modeStrings`

    - ### Fields inherited from class org.apache.commons.net.tftp.TFTPPacket

      `ACKNOWLEDGEMENT, address, DATA, ERROR, MIN_PACKET_SIZE, OACK, port, READ_REQUEST, SEGMENT_SIZE, type, WRITE_REQUEST`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TFTPReadRequestPacket(DatagramPacket datagram)` Creates a read request packet of based on a received datagram and assumes the datagram has already been identified as a read request.
    `TFTPReadRequestPacket(InetAddress destination, int port, String fileName, int mode)` Creates a read request packet to be sent to a host at a given port with a file name and transfer mode request.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `toString()` For debugging

    - ### Methods inherited from class org.apache.commons.net.tftp.TFTPRequestPacket

      `getFilename, getMode, getOptions, newDatagram, newDatagram`

    - ### Methods inherited from class org.apache.commons.net.tftp.TFTPPacket

      `getAddress, getPort, getType, newTFTPPacket, setAddress, setPort`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### TFTPReadRequestPacket

          TFTPReadRequestPacket(DatagramPacket datagram)
                         throws TFTPPacketException

      Creates a read request packet of based on a received datagram and assumes the datagram has already been identified as a read request. Assumes the datagram is at least length 4, else an ArrayIndexOutOfBoundsException may be thrown.
      Parameters:
        `datagram` - The datagram containing the received request.
      Throws:
        `TFTPPacketException` - If the datagram isn't a valid TFTP request packet.

    - #### TFTPReadRequestPacket

          public TFTPReadRequestPacket(InetAddress destination,
                                       int port,
                                       String fileName,
                                       int mode)

      Creates a read request packet to be sent to a host at a given port with a file name and transfer mode request.
      Parameters:
        `destination` - The host to which the packet is going to be sent.
        `port` - The port to which the packet is going to be sent.
        `fileName` - The requested file name.
        `mode` - The requested transfer mode. This should be on of the TFTP class MODE constants (e.g., TFTP.NETASCII_MODE).

  - ### Method Detail

    - #### toString

          public String toString()

      For debugging
      Overrides:
        `toString` in class `TFTPPacket`