|
| |
|
| java.lang.Object
 org.apache.commons.net.DatagramSocketClient
org.apache.commons.net.tftp.TFTP
All known Subclasses: org.apache.commons.net.tftp.TFTPClient,
| Field Summary | |
| final public static int | ASCII_MODE
The ascii transfer mode. | | final public static int | BINARY_MODE
The binary transfer mode. | | final public static int | DEFAULT_PORT
The default TFTP port according to RFC 783 is 69. | | final public static int | DEFAULT_TIMEOUT
The default number of milliseconds to wait to receive a datagram
before timing out. | | final public static int | IMAGE_MODE
The image transfer mode. | | final public static int | NETASCII_MODE
The netascii transfer mode. | | final public static int | OCTET_MODE
The octet transfer mode. | | final static int | PACKET_SIZE
The size to use for TFTP packet buffers. | | byte[] | _sendBuffer
A buffer used to accelerate sends in bufferedSend().
It is left package visible so that TFTPClient may be slightly more
efficient during file sends. |
| Constructor Summary | |
| public | TFTP()
Creates a TFTP instance with a default timeout of DEFAULT_TIMEOUT,
a null socket, and buffered operations disabled. |
| Method Summary | |
| final public void | beginBufferedOps()
Initializes the internal buffers. | | final public TFTPPacket | bufferedReceive()
This is a special method to perform a more efficient packet receive.
It should only be used after calling
TFTP.beginBufferedOps beginBufferedOps() . | | final public void | bufferedSend(TFTPPacket packet)
This is a special method to perform a more efficient packet send.
It should only be used after calling
TFTP.beginBufferedOps beginBufferedOps() . | | final public void | discardPackets()
This method synchronizes a connection by discarding all packets that
may be in the local socket buffer. | | final public void | endBufferedOps()
Releases the resources used to perform buffered sends and receives. | | final public static String | getModeName(int mode)
Returns the TFTP string representation of a TFTP transfer mode.
Will throw an ArrayIndexOutOfBoundsException if an invalid transfer
mode is specified.
Parameters:
mode - The TFTP transfer mode. | | final public TFTPPacket | receive()
Receives a TFTPPacket.
The TFTPPacket received.
exception:
InterruptedIOException - If a socket timeout occurs. | | final public void | send(TFTPPacket packet)
Sends a TFTP packet to its destination. |
| ASCII_MODE | | final public static int ASCII_MODE(Code) | | The ascii transfer mode. Its value is 0 and equivalent to NETASCII_MODE
|
| BINARY_MODE | | final public static int BINARY_MODE(Code) | | The binary transfer mode. Its value is 1 and equivalent to OCTET_MODE.
|
| DEFAULT_PORT | | final public static int DEFAULT_PORT(Code) | | The default TFTP port according to RFC 783 is 69.
|
| DEFAULT_TIMEOUT | | final public static int DEFAULT_TIMEOUT(Code) | | The default number of milliseconds to wait to receive a datagram
before timing out. The default is 5000 milliseconds (5 seconds).
|
| IMAGE_MODE | | final public static int IMAGE_MODE(Code) | | The image transfer mode. Its value is 1 and equivalent to OCTET_MODE.
|
| NETASCII_MODE | | final public static int NETASCII_MODE(Code) | | The netascii transfer mode. Its value is 0.
|
| OCTET_MODE | | final public static int OCTET_MODE(Code) | | The octet transfer mode. Its value is 1.
|
| PACKET_SIZE | | final static int PACKET_SIZE(Code) | | The size to use for TFTP packet buffers. Its 4 plus the
TFTPPacket.SEGMENT_SIZE, i.e. 516.
|
| _sendBuffer | | byte[] _sendBuffer(Code) | | A buffer used to accelerate sends in bufferedSend().
It is left package visible so that TFTPClient may be slightly more
efficient during file sends. It saves the creation of an
additional buffer and prevents a buffer copy in _newDataPcket().
|
| TFTP | | public TFTP()(Code) | | Creates a TFTP instance with a default timeout of DEFAULT_TIMEOUT,
a null socket, and buffered operations disabled.
|
| beginBufferedOps | | final public void beginBufferedOps()(Code) | | Initializes the internal buffers. Buffers are used by
TFTP.bufferedSend bufferedSend() and
TFTP.bufferedReceive bufferedReceive() . This
method must be called before calling either one of those two
methods. When you finish using buffered operations, you must
call
TFTP.endBufferedOps endBufferedOps() .
|
| bufferedReceive | | final public TFTPPacket bufferedReceive() throws IOException, InterruptedIOException, SocketException, TFTPPacketException(Code) | | This is a special method to perform a more efficient packet receive.
It should only be used after calling
TFTP.beginBufferedOps beginBufferedOps() . beginBufferedOps()
initializes a set of buffers used internally that prevent the new
allocation of a DatagramPacket and byte array for each send and receive.
To use these buffers you must call the bufferedReceive() and
bufferedSend() methods instead of send() and receive(). You must
also be certain that you don't manipulate the resulting packet in
such a way that it interferes with future buffered operations.
For example, a TFTPDataPacket received with bufferedReceive() will
have a reference to the internal byte buffer. You must finish using
this data before calling bufferedReceive() again, or else the data
will be overwritten by the the call.
The TFTPPacket received.
exception:
InterruptedIOException - If a socket timeout occurs. TheJava documentation claims an InterruptedIOException is thrownon a DatagramSocket timeout, but in practice we find aSocketException is thrown. You should catch both to be safe.
exception:
SocketException - If a socket timeout occurs. TheJava documentation claims an InterruptedIOException is thrownon a DatagramSocket timeout, but in practice we find aSocketException is thrown. You should catch both to be safe.
exception:
IOException - If some other I/O error occurs.
exception:
TFTPPacketException - If an invalid TFTP packet is received. |
| bufferedSend | | final public void bufferedSend(TFTPPacket packet) throws IOException(Code) | | This is a special method to perform a more efficient packet send.
It should only be used after calling
TFTP.beginBufferedOps beginBufferedOps() . beginBufferedOps()
initializes a set of buffers used internally that prevent the new
allocation of a DatagramPacket and byte array for each send and receive.
To use these buffers you must call the bufferedReceive() and
bufferedSend() methods instead of send() and receive(). You must
also be certain that you don't manipulate the resulting packet in
such a way that it interferes with future buffered operations.
For example, a TFTPDataPacket received with bufferedReceive() will
have a reference to the internal byte buffer. You must finish using
this data before calling bufferedReceive() again, or else the data
will be overwritten by the the call.
Parameters:
packet - The TFTP packet to send.
exception:
IOException - If some I/O error occurs. |
| discardPackets | | final public void discardPackets() throws IOException(Code) | | This method synchronizes a connection by discarding all packets that
may be in the local socket buffer. This method need only be called
when you implement your own TFTP client or server.
exception:
IOException - if an I/O error occurs. |
| endBufferedOps | | final public void endBufferedOps()(Code) | | Releases the resources used to perform buffered sends and receives.
|
| getModeName | | final public static String getModeName(int mode)(Code) | | Returns the TFTP string representation of a TFTP transfer mode.
Will throw an ArrayIndexOutOfBoundsException if an invalid transfer
mode is specified.
Parameters:
mode - The TFTP transfer mode. One of the MODE constants. The TFTP string representation of the TFTP transfer mode. |
| receive | | final public TFTPPacket receive() throws IOException, InterruptedIOException, SocketException, TFTPPacketException(Code) | | Receives a TFTPPacket.
The TFTPPacket received.
exception:
InterruptedIOException - If a socket timeout occurs. TheJava documentation claims an InterruptedIOException is thrownon a DatagramSocket timeout, but in practice we find aSocketException is thrown. You should catch both to be safe.
exception:
SocketException - If a socket timeout occurs. TheJava documentation claims an InterruptedIOException is thrownon a DatagramSocket timeout, but in practice we find aSocketException is thrown. You should catch both to be safe.
exception:
IOException - If some other I/O error occurs.
exception:
TFTPPacketException - If an invalid TFTP packet is received. |
| send | | final public void send(TFTPPacket packet) throws IOException(Code) | | Sends a TFTP packet to its destination.
Parameters:
packet - The TFTP packet to send.
exception:
IOException - If some I/O error occurs. |
|
|
|