|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.net.tftp.TFTPPacket
TFTPPacket is an abstract class encapsulating the functionality common to the 5 types of TFTP packets. It also provides a static factory method that will create the correct TFTP packet instance from a datagram. This relieves the programmer from having to figure out what kind of TFTP packet is contained in a datagram and create it himself.
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.
TFTPPacketException
,
TFTP
Field Summary | |
---|---|
(package private) java.net.InetAddress |
_address
The host the packet is going to be sent or where it came from. |
(package private) int |
_port
The port the packet came from or is going to. |
(package private) int |
_type
The type of packet. |
static int |
ACKNOWLEDGEMENT
This is the actual TFTP spec identifier and is equal to 4. |
static int |
DATA
This is the actual TFTP spec identifier and is equal to 3. |
static int |
ERROR
This is the actual TFTP spec identifier and is equal to 5. |
(package private) static int |
MIN_PACKET_SIZE
The minimum size of a packet. |
static int |
READ_REQUEST
This is the actual TFTP spec identifier and is equal to 1. |
static int |
SEGMENT_SIZE
The TFTP data packet maximum segment size in bytes. |
static int |
WRITE_REQUEST
This is the actual TFTP spec identifier and is equal to 2. |
Constructor Summary | |
---|---|
(package private) |
TFTPPacket(int type,
java.net.InetAddress address,
int port)
This constructor is not visible outside of the package. |
Method Summary | |
---|---|
(package private) abstract java.net.DatagramPacket |
_newDatagram(java.net.DatagramPacket datagram,
byte[] data)
This is an abstract method only available within the package for implementing efficient datagram transport by elminating buffering. |
java.net.InetAddress |
getAddress()
Returns the address of the host where the packet is going to be sent or where it came from. |
int |
getPort()
Returns the port where the packet is going to be sent or where it came from. |
int |
getType()
Returns the type of the packet. |
abstract java.net.DatagramPacket |
newDatagram()
Creates a UDP datagram containing all the TFTP packet data in the proper format. |
static TFTPPacket |
newTFTPPacket(java.net.DatagramPacket datagram)
When you receive a datagram that you expect to be a TFTP packet, you use this factory method to create the proper TFTPPacket object encapsulating the data contained in that datagram. |
void |
setAddress(java.net.InetAddress address)
Sets the host address where the packet is going to be sent. |
void |
setPort(int port)
Sets the port where the packet is going to be sent. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
static final int MIN_PACKET_SIZE
public static final int READ_REQUEST
public static final int WRITE_REQUEST
public static final int DATA
public static final int ACKNOWLEDGEMENT
public static final int ERROR
public static final int SEGMENT_SIZE
int _type
int _port
java.net.InetAddress _address
Constructor Detail |
TFTPPacket(int type, java.net.InetAddress address, int port)
type
- The type of the packet.address
- The host the packet came from or is going to be sent.port
- The port the packet came from or is going to be sent.Method Detail |
public static final TFTPPacket newTFTPPacket(java.net.DatagramPacket datagram) throws TFTPPacketException
datagram
- The datagram containing a TFTP packet.
TFTPPacketException
- If the datagram does not contain a valid
TFTP packet.abstract java.net.DatagramPacket _newDatagram(java.net.DatagramPacket datagram, byte[] data)
datagram
- The datagram to create.data
- The buffer to store the packet and to use in the datagram.
public abstract java.net.DatagramPacket newDatagram()
public final int getType()
public final java.net.InetAddress getAddress()
public final int getPort()
public final void setPort(int port)
public final void setAddress(java.net.InetAddress address)
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |