ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.oroinc.net.tftp.TFTPDataPacket

java.lang.Object
   |
   +----com.oroinc.net.tftp.TFTPPacket
           |
           +----com.oroinc.net.tftp.TFTPDataPacket

public final class TFTPDataPacket
extends TFTPPacket
A final class derived from TFTPPacket definiing the TFTP Data 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.

Copyright © 1997 Original Reusable Objects, Inc. All rights reserved.

See Also:
TFTPPacket, TFTPPacketException, TFTP

Variable Index

 o MAX_DATA_LENGTH
The maximum number of bytes in a TFTP data packet (512)
 o MIN_DATA_LENGTH
The minimum number of bytes in a TFTP data packet (0)

Constructor Index

 o TFTPDataPacket(InetAddress, int, int, byte[])
 o TFTPDataPacket(InetAddress, int, int, byte[], int, int)
Creates a data packet to be sent to a host at a given port with a given block number.

Method Index

 o getBlockNumber()
Returns the block number of the data packet.
 o getData()
Returns the byte array containing the packet data.
 o getDataLength()
Returns the length of the data part of the data packet.
 o getDataOffset()
Returns the offset into the byte array where the packet data actually starts.
 o newDatagram()
This is a method exposed to the programmer in case he wants to implement his own TFTP client instead of using the TFTPClient class.
 o setBlockNumber(int)
Sets the block number of the data packet.
 o setData(byte[], int, int)
Sets the data for the data packet.

Variables

 o MAX_DATA_LENGTH
 public static final int MAX_DATA_LENGTH
The maximum number of bytes in a TFTP data packet (512)

 o MIN_DATA_LENGTH
 public static final int MIN_DATA_LENGTH
The minimum number of bytes in a TFTP data packet (0)

Constructors

 o TFTPDataPacket
 public TFTPDataPacket(InetAddress destination,
                       int port,
                       int blockNumber,
                       byte data[],
                       int offset,
                       int length)
Creates a data packet to be sent to a host at a given port with a given block number. The actual data to be sent is passed as an array, an offset, and a length. The offset is the offset into the byte array where the data starts. The length is the length of the data. If the length is greater than MAX_DATA_LENGTH, it is truncated.

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.
blockNumber - The block number of the data.
data - The byte array containing the data.
offset - The offset into the array where the data starts.
length - The length of the data.
 o TFTPDataPacket
 public TFTPDataPacket(InetAddress destination,
                       int port,
                       int blockNumber,
                       byte data[])

Methods

 o newDatagram
 public DatagramPacket newDatagram()
This is a method exposed to the programmer in case he wants to implement his own TFTP client instead of using the TFTPClient class. Under normal circumstances, you should not have a need to call this method. It creates a UDP datagram containing all the TFTP data packet data in the proper format.

Returns:
A UDP datagram containing the TFTP data packet.
Overrides:
newDatagram in class TFTPPacket
 o getBlockNumber
 public int getBlockNumber()
Returns the block number of the data packet.

Returns:
The block number of the data packet.
 o setBlockNumber
 public void setBlockNumber(int blockNumber)
Sets the block number of the data packet.

 o setData
 public void setData(byte data[],
                     int offset,
                     int length)
Sets the data for the data packet.

Parameters:
data - The byte array containing the data.
offset - The offset into the array where the data starts.
length - The length of the data.
 o getDataLength
 public int getDataLength()
Returns the length of the data part of the data packet.

Returns:
The length of the data part of the data packet.
 o getDataOffset
 public int getDataOffset()
Returns the offset into the byte array where the packet data actually starts.

Returns:
The offset into the byte array where the packet data actually starts.
 o getData
 public byte[] getData()
Returns the byte array containing the packet data.

Returns:
The byte array containing the packet data.

ORO, Inc. Logo  All Packages  Class Hierarchy  This Package  Previous  Next  Index