|
||||||||||
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
public abstract class 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 | |
---|---|
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. |
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. |
Method Summary | |
---|---|
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 DatagramPacket |
newDatagram()
Creates a UDP datagram containing all the TFTP packet data in the proper format. |
static TFTPPacket |
newTFTPPacket(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(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 |
---|
public static final int READ_REQUEST
getType()
indicating a read request packet.
public static final int WRITE_REQUEST
getType()
indicating a write request packet.
public static final int DATA
getType()
indicating a data packet.
public static final int ACKNOWLEDGEMENT
getType()
indicating an acknowledgement packet.
public static final int ERROR
getType()
indicating an error packet.
public static final int SEGMENT_SIZE
TFTP
class methods to implement their own TFTP servers or clients.
Method Detail |
---|
public static final TFTPPacket newTFTPPacket(DatagramPacket datagram) throws TFTPPacketException
datagram
- The datagram containing a TFTP packet.
TFTPPacketException
- If the datagram does not contain a valid
TFTP packet.public abstract DatagramPacket newDatagram()
TFTPClient
class.
Under normal circumstances, you should not have a need to call this
method.
public final int getType()
public final InetAddress getAddress()
public final int getPort()
public final void setPort(int port)
public final void setAddress(InetAddress address)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |